chore: Update workflows and automate releases #125
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Gudahtt
force-pushed
the
update-github-action-workflows
branch
3 times, most recently
from
f109323 to
3edae66
Compare
The GitHub Action workflows have been updated based on the module template. The changes made from the template are: * There are no tests, so the test step from "build-lint-test" was removed. * The "build" step is now run on three Node.js versions rathern than just one. In the template we rely more on tests for compatibility, but that won't work with no tests of course. * The "build" step builds the demo, not the package. There is no build step for the package, it's not in TypeScript (yet). * The API doc publishing was removed (this repo uses the `gh-pages` branch for the demo). * The changelog doesn't use Prettier formatting yet (this requires more lint tooling/config updates). The changes made from the previous workflows in this repository are: * Automated npm publishing * Removed "require additional reviewer" workflow (we've stopped using this) * Additional workflow linting * Updated vertions of various actions * Update base image to `ubuntu-latest` * Add Node.js v22.x to the test matrix * Add checks for a dirty working tree Additionally, the "publish-gh-pages" workflow was updated to use the same "checkout, install Node.js, and install dependencies" steps as elsewhere. This workflow has no analog in the module template.
Gudahtt
force-pushed
the
update-github-action-workflows
branch
from
3edae66 to
23bccc9
Compare
Gudahtt
commented
Feb 12, 2025
| publish-npm: | ||
| needs: publish-npm-dry-run | ||
| runs-on: ubuntu-latest | ||
| environment: npm-publish |
Member
Author
There was a problem hiding this comment.
A new npm-publish environment and access token has been setup for this.
Gudahtt
commented
Feb 12, 2025
Gudahtt
commented
Feb 12, 2025
| build-lint: | ||
| name: Build and Lint | ||
| env: | ||
| INFURA_PROJECT_ID: ${{ secrets.INFURA_PROJECT_ID }} |
Member
Author
There was a problem hiding this comment.
This was already unused (and not setup in repo settings). Must have been added by mistake.
mcmire
reviewed
Feb 12, 2025
Contributor
mcmire
left a comment
mcmire
left a comment
There was a problem hiding this comment.
One comment about package.json.
| "convert": "node scripts/convert.js", | ||
| "demo": "node demo/build.js", | ||
| "demo:all": "yarn demo --all", | ||
| "lint": "yarn lint:eslint && yarn lint:misc --check", |
Contributor
There was a problem hiding this comment.
Worth adding lint:changelog to lint too?
Suggested change
| "lint": "yarn lint:eslint && yarn lint:misc --check", | |
| "lint": "yarn lint:eslint && yarn lint:misc --check && yarn lint:changelog", |
Member
Author
There was a problem hiding this comment.
Ah right, I meant to comment on this. I considered this change, but I noticed the changelog lint is run redundantly in our workflows now in the module template.
It's run once as part of yarn lint (with the --rc flag always unset), then it's run again with the correct --rc flag set (depending on the branch it's run on).
Co-authored-by: Elliot Winkler <[email protected]>
NidhiKJha
approved these changes
Feb 13, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
The GitHub Action workflows have been updated based on the module template.
The changes made from the template are:
build-lintworkflow builds the demo, not the package. There is no build step for the package, it's not in TypeScript (yet).gh-pagesbranch for the demo).The changes made from the previous workflows in this repository are:
ubuntu-latestAdditionally, the "publish-gh-pages" workflow was updated to use the same "checkout, install Node.js, and install dependencies" steps as elsewhere. This workflow has no analog in the module template.