Development

Install the dependencies

npm install

Run the tests ✔️

$ npm test

 PASS  ./index.test.js
  ✓ test case (3ms)
...

Change action.yml

The action.yml defines the inputs and output for your action.

Update the action.yml with your name, description, inputs and outputs for your action.

See the documentation

Change the Code

Most toolkit and CI/CD operations involve async operations so the action is run in an async function.

const core = require('@actions/core');
...

async function run() {
  try {
  ...
  } catch (error) {
    core.setFailed(error.message);
  }
}

run()

See the toolkit documentation for the various packages.

Create a release branch

Users shouldn't consume the action from master since that would be latest code and actions can break compatibility between major versions.

Run RELEASE manual workflow and add version i.e. v1

Your action is now published! 🚀

See the versioning documentation

Usage

You can now consume the action by referencing the v1 branch

uses: allegro-actions/your-action-name@v1