Skip to content

Commit e452304

Browse files
authored
Add notes explaining how to make a release (#13)
1 parent 9464d2f commit e452304

File tree

1 file changed

+26
-0
lines changed

1 file changed

+26
-0
lines changed

RELEASE.md

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
# Making a new release of git2cpp
2+
3+
This covers making a new github release in the `git2cpp` repository, and propagating that release through to Emscripten-forge so that the new WebAssembly package is available in the Jupyterlite terminal.
4+
5+
## Github release
6+
7+
1. Submit and merge a `git2cpp` PR bumping the version number in `version.hpp`.
8+
2. Fetch the latest changes to your local `git2cpp` repo.
9+
3. Tag the new release using something like `git tag -a 0.0.2 -m "Version 0.0.2"`. Ideally sign the release by adding the `-s` flag.
10+
4. Push the new tag to the github repo using `git push upstream --tags`.
11+
5. Create a github release for the tag. In https://github.com/QuantStack/git2cpp:
12+
13+
- Click on `Releases`.
14+
- Click on `Draft a new release`.
15+
- Select the new tag in the `Choose a tag` dropdown.
16+
- Click on `Generate release notes`. This will fill out the release notes based on the PRs merged since the last release.
17+
- Edit the release notes if desired.
18+
- Click on `Publish release`.
19+
20+
## Update Emscripten-forge recipe
21+
22+
The Emscripten-forge recipe at https://github.com/emscripten-forge/recipes needs to be updated with the new version number and SHA checksum. An Emscripten-forge bot runs once a day and will identify the new github release and create a PR to update the recipe. Wait for this to happen, and if the tests pass and no further changes are required, the PR can be approved and merged.
23+
24+
After the PR is merged to `main`, the recipe will be rebuilt and uploaded to https://prefix.dev/channels/emscripten-forge-dev/packages/git2cpp, which should only take a few minutes.
25+
26+
Any subsequent `cockle` or JupyterLite `terminal` deployments that are rebuilt will download and use the latest `git2cpp` WebAssembly package.

0 commit comments

Comments
 (0)