Custom Actions

This repo contains the code for custom GitHub Workflow actions. Most of the actions are composite actions, but some are written in JS for more flexibility. The JS actions require a build step before pushing changes.

Install all packages at the top level. To build all of the subpackages from the top level: npm run build.

More info on JS actions in the GitHub docs.

For info on the @actions toolkit helpers see the GitHub Actions Toolkit documentation.

Tip for testing your actions

You can point workflows at your changes to an action, or a new action that you are developing. In the workflows just change the @v2.1 part of the action reference to your branch, e.g. ObamaFoundation/actions/my-action@my-branch.

Tags

The version tags follow semver.org with the expectation that workflows will specify a major and minor version, e.g. @v2.1. Thus when merging changes, increment the major or minor version if exciting workflows might break because of the changes. Increment the patch version if the changes will have no impact on existing workflows.

To tag a commit:

• Merge your change into main branch.
• git checkout main
• git pull --tags -f
• Look at https://github.com/ObamaFoundation/actions/tags and use the next highest major, minor, or patch version per the guidelines above (e.g. v1.0.9):
• git tag -a -m "Explain the changes" <vX.Y.Z>
• git push origin <vX.Y.Z>
• If you've made large changes, this is a good point to test them. Changing the major or minor version could break existing workflows.
  • In obamaorg-swa repo on a new branch, change all with regex (ObamaFoundation/actions/.*)@v[\d.]+ to your new version [email protected] in the .github directory.
  • Push the change and create a temporary pull request, which will fire off a build.
  • Make sure the build succeeds.
  • Delete the temporary pull request.
  • Continue below.
• While still on main branch in the actions repo, move the minor release with: git tag -f <vX.Y>
• And push that tag change: git push -f origin <vX.Y>

Note: To see where a tag is currently pointing (locally): git rev-list -n 1 vX.Y.Z.

Testing

The workflows in .github/workflows automatically run on every pull request and block merging on failure.

Note that the ACTIONS_STEP_DEBUG repo variable can be set to true to enable more debug logging.