martijnarts / relez

A set of reusable Github Workflows that help release my code.

Hi there 👋

Find me online at martijnarts.com: my personal homepage, digital garden, etc.; blog.martijnarts.com, where I write about my projects.

All other profiles linked on Keyoxide.

Found a problem with one of my open source repositories that you want to help resolve? Let's pair on it! Pick some time here: https://cal.com/martijnarts/pairing

relez's Issues

Write workflow to maintain release PR

In my initial idea of the release flow, we'll have a workflow run on main that maintains a Git branch and Github PR that would release any draft changes in main. We need to:

• Write the workflow
• Write tests for it
• Document it
• Extend the script created in #3 to add any potential additionally needed secrets

The workflow should:

1. Check out (and optionally create) the release-draft branch
2. Clear any .changelog/vX.Y.Z.json files made in this branch
3. Regenerate the CHANGELOG.md and .changelog/vX.Y.Z.json file from the .changelog/draft/ directory
4. Commit and push the changes
5. If necessary, create a PR on Github

Switch to act for non-integration tests

Currently, we create a clean Github repository and running integration tests there.. Github probably won't like this approach, so we should switch to act for non-integration tests.

Finish pr-changelog.yml

To finish this, we should:

• Document how it works
• Maybe write a script to install, generate, and provision the right secrets?

Write workflow to trigger releasing

When the release branch (#4) is merged, we should trigger a release. We need to:

• Write the workflow
• Write tests for it
• Document it
• Extend the installation script created in #3 to add any potential additionally needed secrets

The workflow should trigger on changes to .changelog/v*.json, and do:

1. Check if the change was creating a new file, fail otherwise (old changelogs should not be edited)
2. Tag the commit with the version number and a summary of the changes
3. Push the tag
4. Create a Github Release from the tag

Run integration testing from Github Actions?

This might be crazy, but what if we ran integration tests from GHA. We could use a single repository and clean it out before each test run, and automatically run the integration tests on any push to main?