GitProxy Release Guide

[jescalada]

GitProxy's release process has been revamped over the last few months, enabling more stable, but also faster releases via automated workflows. Although we have an in-depth release guide on our website, I made a short demo with screenshots to make the flow easy to reproduce.

This is a step-by-step demo of how to make a new release:

Major/Minor releases

1. Close the milestone issue

When closing a milestone, a version bump PR will automatically open:

Alternatively, run the workflow manually

The version bump workflow can be triggered manually from this link:

2. Review the generated package.json bump PR and merge it

A PR will be generated to bump @finos/git-proxy to the right version based on the milestone or the version chosen on manual dispatch;

If everything looks fine (no unexpected changes or CI failures), approve and merge this PR.

3. Make the release/X.Y branch from main

Head over to the branches page and make a new release branch with the right version:

This should automatically draft a release for your desired version:

If you don't see the release, check the release drafter workflow page to see the latest run:

4. Review/enhance the release notes and publish

Check out the generated release notes, add any details that could help users be more aware of the important changes being shipped, and finally publish the GitHub release:

This will automatically publish to NPM as well.

5. Check that NPM publish worked as expected

After publishing the release notes, our NPM workflow automatically publishes @finos/git-proxy to NPM. Make sure that the release was published without issue:

Patch Releases

A demo covering patch releases (and cascade merging) will be added when we make an actual patch release. For now, check out the Patch Release Guide section on the website guide.

Troubleshooting

If you have any problems, make an issue and ping @jescalada to investigate.