Code in Main

Install the dependencies

$ yarn

Build the typescript and package it for distribution

$ yarn build

Run the tests ✔️

$ yarn test
...

Publish to a distribution branch

Actions are run from GitHub repos so we will checkin the packed dist folder.

Then run ncc and push the results:

$ yarn dist
$ git add dist
$ git commit -a -m "prod dependencies"
$ git push origin main

Your action is now published! 🚀

See the versioning documentation

Usage:

In your workflow file

  - name: Generate SQL for migration
    uses: getsentry/action-migrations@v1.0.7
    env:
      SENTRY_LOG_LEVEL: ERROR
      PGPASSWORD: postgres
    with:
      githubToken: ${{ secrets.GITHUB_TOKEN }}
      migration: "./path/to/migration"

See action.yml for more arguments.

The action keeps one comment per name. It edits that comment when nothing but this action's comments follow it, or when the SQL is unchanged. Otherwise it posts a new comment at the bottom and deletes the old ones.

Drafting a new release

Anybody from engineering can release. Just go to GitHub's create release page and do it. Create a new tag vX.Y.Z, the rest doesn't really matter.