A monorepo for shared github actions.
Currently only composite actions are supported, although supporting nodejs actions probably wouldn't be too hard. If your script is simple, you can do a composite action that uses actions/github-script, see the filter-files action for an example.
Github doesn't support putting actions in subdirectories, so we need to do some fancy work here. Inspired by gitpkg, we "publish" versions of our actions to 'bare tags' in this repo. So the tag filter-files-v0.0.1 would only contain the files for the filter-files action, and thus github is perfectly happy for us to reference it as uses: @Khan/actions#filter-files-v0.0.1.
Actions that depend on other actions within this repo (with e.g. uses: filter-files) will have the references automatically converted to the appropriated pinned reference (e.g. Khan/actions#filter-files-v0.0.1) as part of the publish process.
Changeset helps us track what needs to be published, and automatically produces a changelog, so we know what changed in a given release.
(Note [Lilli]: I don't know if there's a better way; this is just what I did.)
Let's say I want to test a change to the gerald-pr action, pointed to from a different repo. I'm still working on it, so I don't want to publish it yet (as described above). I still need to get the action isolated in its own folder, outside the sub-folders of the monorepo.
Here's what I did:
- Find the last tagged-and-published version of that action (e.g.,
gerald-pr-v0.0.1). - Run
git checkout gerald-pr-v0.0.1to create a detached HEAD. - Run
git checkout -b <branch-name>to create a new branch with just those files. - Apply the changes to my development branch to this branch. Sometimes
git cherry-pickcan figure out the file-structure differences across branches. You can also manually create and apply patches. Or just manually bring in the changes, if they're small enough and you're careful enough. - Push the branch to the GitHub.
- Point my other repo to my test branch with
uses: @Khan/actions@<branch-name>.