Project Actions

Project Actions are like Github Actions for your projects. Write workflows in YAML and run them via a command-line interface.

Key Features

No Long Hard-to-Read Bash Scripts:
Like Github Actions, but for your projects, no more bespoke bash scripts to maintain.
Multi-Platform Command Runner:
Runs on Mac, or Linux (for example inside your docker container)
Docker Container Friendly:
Commands can be run inside or outside of a docker container
Automatic Help Messaging:
Help messages are automatically generated from your YAML files
Project Integration:
Works seamlessly with your existing project structure.

Installation


                    $ curl -s https://project-actions.org/install.sh | bash

Usage


                    $ project help

Typical (Built-in) Commands


                    $ project up


                    $ project down


                    $ project console


                    $ project refresh

Layout & Files

Project Actions uses a simple YAML files to define commands located in the .project/workflows directory. Here is a sample workflow for an up command:


help:
  short: Bring the project up
  long: |
    This command is used to bring the project up, which includes starting
    all necessary services and ensuring the environment is ready for use.

    Note: If you are running this for the first time, you should run
    `project setup` first.
  order: 2

context: outside-container

steps:
  - action: compose-up
  - echo: "Project is now up and running"

  - if-option: refresh|fresh
    then:
      - command: refresh

  - echo: |
      The project is now up and running. You can access it at:
      - Web: http://localhost:8000