Giter Club home page Giter Club logo

archetect-render-action's Introduction

archetect render GitHub Action

Maintained by Scaffoldly GitHub release (latest SemVer) Archetect Version

This action runs an Archetect render command using template files contained in source and outputs to destination.

source can be a directory relative to where the action is running or a URL to a Git repository (e.g. https://github.com/scaffoldly/archetype-scaffoldly-bootstrap.git).

Inputs

source (Required)

The source directory or Git repo containing an archetype.yml

Can also contain an optional Git Reference, e.g. https://github.com/scaffoldly/archetype-scaffoldly-bootstrap.git#1.0.0

destination (Optional)

The destination of the rendered output

Default: .

options (Optional)

Additional command-line options for the archetect command (e.g. -a, -A, -s)

From archetect render --help:

FLAGS:
    -h, --help
            Prints help information

    -o, --offline
            Only use directories and already-cached remote git URLs

    -V, --version
            Prints version information

    -v, --verbose
            Increases the level of verbosity

OPTIONS:
    -a, --answer <key=value>...
            Supply a key=value pair as an answer to a variable question. This option may be specified more than once.

            Valid Input Examples:

            key=value
            key='multi-word value'
            key="multi-word value"
            "key=value"
            'key=value'
            'key="multi-word value"'
            "key = 'multi-word value'"
    -A, --answer-file <path>...
            Supply an answers file as answers to variable questions. This option may be specified more than once.

    -s, --switch <switches>...
            Enable switches that may trigger functionality within Archetypes

Default: `` (empty string)

commit (Optional)

If set, changes will be committed back into the repository

Default: "true"

post-render-command (Optional)

If set, a command to run post rendering (e.g. code formatting)

Default: ""

Outputs

This action has no outputs

Example usage

Run a archetect render and provide answers as options:

- uses: actions/checkout@v2
- uses: scaffoldly/archetect-render-action@v1
  with:
    source: "https://github.com/scaffoldly/archetype-scaffoldly-bootstrap.git"
    options: "-a nonlive_domain=myproject.dev -a live_domain=myproject.com"

Run a archetect render and provide an answers file:

- uses: actions/checkout@v2
- uses: scaffoldly/archetect-render-action@v1
  with:
    source: "https://github.com/scaffoldly/archetype-scaffoldly-bootstrap.git"
    options: "-A ./path/to/answers.yml"

archetect-render-action's People

Contributors

cnuss avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.