Skip to content

Commit 1491581

Browse files
committed
docs: add npm publish and patch release sections
1 parent dce2514 commit 1491581

1 file changed

Lines changed: 19 additions & 0 deletions

File tree

docs/Releases.md

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -63,3 +63,22 @@ When a release is ready to ship, a maintainer:
6363
3. Clicks Publish.
6464

6565
Publishing creates a git tag, and triggers the `npm.yml` workflow described below.
66+
67+
### Publish to NPM
68+
69+
This workflow, detailed in [`npm.yml`](https://github.com/finos/git-proxy/blob/main/.github/workflows/npm.yml), builds and publishes the package to NPM. It:
70+
71+
1. Builds the package
72+
2. Detects whether it's the latest version (e.g.: if the version you're publishing is `2.3`, and the latest on NPM `2.2`)
73+
a) If it's the latest version, it gets tagged as `'latest'` which is the default version that gets installed when calling `npx @finos/git-proxy`
74+
b) If it's a maintenance release on an older line, it gets tagged as `vX.Y` so users can pin it explicitly if needed
75+
76+
3) Publishes the package with the tag defined above
77+
78+
### Publishing a Patch Release
79+
80+
For patch releases, the same process applies. The only difference is that first we must perform the cascade-based flow from above. Once the fix has been completed and merged into all the affected versions' release branches, a maintainer can publish each new version immediately from the drafts generated by `release-drafter.yml`. Alternatively, they can wait until enough minor fixes have accumulated, and then publish when ready.
81+
82+
## Questions
83+
84+
If you have any questions or suggestions regarding releases, feel free to [open a discussion](https://github.com/finos/git-proxy/discussions).

0 commit comments

Comments
 (0)