Skip to content
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.

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

ci: add support for automated releases #42

Closed
wants to merge 3 commits into from

Conversation

KevinEady
Copy link
Contributor

@KevinEady KevinEady commented May 17, 2024

Creates two new jobs, prepare-release and publish-release, as discussed in #13 (comment).

The publish-release job requires a CI env secret, NPM_TOKEN, as discussed here: Publishing packages to the npm registry.

The publish-release job is not fully automated, and must be ran manually from the GitHub Actions interface.

This PR also updates sync-headers to close outdated PRs if a new change comes in.

Fixes: #13

@KevinEady
Copy link
Contributor Author

KevinEady commented May 17, 2024

A test run on my local fork created these artifacts:

  • prepare-release [Run log]

    • Created PR to update package.json and CHANGELOG.md
  • publish-release [Run log]

    • Ran npm publish (disabled on my fork via echo, but can see in run log)
    • Created tag v1.2.0
    • Created GitHub release Release 1.2.0
      • The release notes are automatically generated by GitHub's Release API and are based on pull requests, so that's why these release notes do not contain all the relevant PRs that are on this official nodejs repo.
      • To preview what the release notes would look like, you can use the GitHub interface to create a new release (but do NOT publish / save draft)

@KevinEady
Copy link
Contributor Author

We discussed in the 17 May Node-API meeting that the manual running of publish-release is acceptable, and in the future, we can make it automated if we see that we continuously run it manually with no problems.

@KevinEady
Copy link
Contributor Author

I'm moving this back to draft, as the custom release code could be replaced with https://github.com/googleapis/release-please-action similarly to nodejs/node-addon-api#1523.

@KevinEady KevinEady marked this pull request as draft June 26, 2024 12:11
@legendecas
Copy link
Member

The release process was verified at nodejs/node-addon-api#1526. We can move this forward as well!

@KevinEady
Copy link
Contributor Author

Closing in favor of #43 , #44

@KevinEady KevinEady closed this Jul 9, 2024
@KevinEady KevinEady deleted the automated-release branch July 9, 2024 18:51
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Investigate automation of publishing new npm versions
3 participants