Skip to content

Replace prebuild upload with gh release create for immutable releases #294

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
tidy-dev wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Replace prebuild upload with gh release create for immutable releases #294

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 4 additions & 3 deletions .github/workflows/ci.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ jobs:
name: Build
runs-on: windows-2022
permissions:
contents: read
contents: write
strategy:
fail-fast: false
matrix:
Expand Down Expand Up @@ -46,6 +46,7 @@ jobs:
run: npm run prebuild-napi-ia32
- name: Publish
if: github.event_name == 'push' && startsWith(github.ref, 'refs/tags/')
run: yarn upload
run: |
gh release create ${{ github.ref_name }} prebuilds/*.tar.gz --generate-notes --draft
env:
GITHUB_AUTH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
11 changes: 8 additions & 3 deletions docs/releases.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,13 +8,18 @@ of the form `releases/x.x.x`
After running commands in 'Publishing to NPM', the release branch should be
pushed. Now, you need to get it reviewed and merged.

After that, don't forget publish the release on the repo.
After merging, pushing the tag (via `npm publish`) will trigger CI which creates
a **draft** GitHub release with prebuilt binaries attached. To finalize:

- Go to https://github.com/desktop/registry-js/releases
- Click click `Draft a New Release`
- Fill in form
- Find the draft release created by CI
- Review that all assets are present (3 `.tar.gz` files)
- Hit `Publish release`

> **Note:** Publishing the release makes it immutable — assets and the tag can no
> longer be modified. If something is wrong, delete the draft and cut a new
> version.

## Publishing to NPM

Releases are done to NPM, and are currently limited to the core team.
Expand Down
Loading