Improve build for packaging, add release workflow in CI #212
There are no files selected for viewing
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,60 @@ | ||
| name: Update version on new release branch | ||
|
|
||
| on: | ||
| create: | ||
|
|
||
| permissions: | ||
| contents: write | ||
| pull-requests: write | ||
|
|
||
| jobs: | ||
| update_version: | ||
| if: github.ref_type == 'branch' && startsWith(github.ref, 'refs/heads/release-v') | ||
| runs-on: ubuntu-latest | ||
|
|
||
| steps: | ||
| - name: Checkout repository | ||
| uses: actions/checkout@v5 | ||
|
|
||
| - name: Extract current version | ||
| run: | | ||
| CURRENT_VERSION=$(node -p "require('./contracts/package.json').version") | ||
|
There was a problem hiding this comment. I'm wondering if nodejs is available in the runner?
Member
There was a problem hiding this comment. I think it is supported in the runner but I will add this part to be safe: |
||
| echo "CURRENT_VERSION=$CURRENT_VERSION" >> "$GITHUB_ENV" | ||
| - name: Extract new version number | ||
| run: echo "NEW_VERSION=${GITHUB_REF#refs/heads/release-v}" >> "$GITHUB_ENV" | ||
|
|
||
| - name: Replace version in files | ||
| run: | | ||
| echo "Current version: $CURRENT_VERSION" | ||
| echo "New version: $NEW_VERSION" | ||
| # Update package.json version field manually | ||
| cd contracts | ||
| node -e " | ||
| const fs = require('fs'); | ||
| const pkg = require('./package.json'); | ||
| pkg.version = '$NEW_VERSION'; | ||
| fs.writeFileSync('./package.json', JSON.stringify(pkg, null, 2) + '\n'); | ||
| console.log('Updated package.json to version $NEW_VERSION'); | ||
| " | ||
| # Update yarn.lock to reflect the new version | ||
| yarn install | ||
| cd .. | ||
| # Escape special characters for sed | ||
| ESCAPED_CURRENT=$(printf '%s' "$CURRENT_VERSION" | sed -e 's/[\/&]/\\&/g') | ||
| ESCAPED_NEW=$(printf '%s' "$NEW_VERSION" | sed -e 's/[\/&]/\\&/g') | ||
| # Replace version in contracts/src/ | ||
| find ./contracts/src/ -type d -name '.*' -prune -o \ | ||
| -type f -exec sed -i "s#$ESCAPED_CURRENT#$ESCAPED_NEW#g" {} + | ||
| # Replace version in docs/, excluding package-lock.json | ||
| find ./docs/ -type d -name '.*' -prune -o \ | ||
| -type f ! -name 'package-lock.json' -exec sed -i "s#$ESCAPED_CURRENT#$ESCAPED_NEW#g" {} + | ||
| - name: Auto-commit changes | ||
| uses: stefanzweifel/git-auto-commit-action@778341af668090896ca464160c2def5d1d1a3eb0 #v6.0.1 | ||
| with: | ||
| commit_message: Bump version to ${{ env.NEW_VERSION }} | ||
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,94 @@ | ||
| name: Publish Package on Release | ||
|
|
||
| on: | ||
| release: | ||
| types: [published] | ||
|
|
||
| jobs: | ||
| publish: | ||
| runs-on: ubuntu-latest | ||
| permissions: | ||
| contents: read | ||
| id-token: write | ||
|
|
||
| steps: | ||
| - name: Checkout | ||
| uses: actions/checkout@v5 | ||
|
|
||
| - name: Setup Environment | ||
| uses: ./.github/actions/setup | ||
|
|
||
| - name: Build contracts | ||
| run: turbo build --filter=!'docs' | ||
|
|
||
| - name: Validate version consistency | ||
| run: | | ||
| RELEASE_VERSION=${GITHUB_REF#refs/tags/v} | ||
| PACKAGE_VERSION=$(node -p "require('./contracts/package.json').version") | ||
| if [ "$RELEASE_VERSION" != "$PACKAGE_VERSION" ]; then | ||
| echo "❌ Version mismatch: Release $RELEASE_VERSION vs Package $PACKAGE_VERSION" | ||
| exit 1 | ||
| fi | ||
| echo "✅ Version consistency validated: $RELEASE_VERSION" | ||
| - name: Setup npm registry | ||
| uses: actions/setup-node@v4 | ||
| with: | ||
| registry-url: 'https://registry.npmjs.org' | ||
|
|
||
| - name: Pack tarball | ||
| id: pack | ||
| run: | | ||
| cd contracts/dist | ||
| TARBALL=$(npm pack | tail -1) | ||
| echo "tarball_name=$TARBALL" >> $GITHUB_OUTPUT | ||
| echo "tarball=$(pwd)/$TARBALL" >> $GITHUB_OUTPUT | ||
| # Determine dist-tag based on semver prerelease | ||
| PACKAGE_VERSION=$(node -p "require('./package.json').version") | ||
| if [[ "$PACKAGE_VERSION" =~ -.*$ ]]; then | ||
| # Has prerelease suffix (anything after -) | ||
| if [[ "$PACKAGE_VERSION" =~ -(alpha|beta|rc) ]]; then | ||
| echo "tag=beta" >> $GITHUB_OUTPUT | ||
| else | ||
| echo "tag=next" >> $GITHUB_OUTPUT | ||
| fi | ||
| else | ||
| # Stable release | ||
| echo "tag=latest" >> $GITHUB_OUTPUT | ||
| fi | ||
| - name: Verify tarball integrity | ||
| run: | | ||
| echo "=== Verifying tarball contents ===" | ||
| PACKAGE_NAME=$(tar xfO "${{ steps.pack.outputs.tarball }}" package/package.json | jq -r .name) | ||
| PACKAGE_VERSION=$(tar xfO "${{ steps.pack.outputs.tarball }}" package/package.json | jq -r .version) | ||
| PRIVATE_FIELD=$(tar xfO "${{ steps.pack.outputs.tarball }}" package/package.json | jq -r '.private // "not found"') | ||
| echo "📦 Package: $PACKAGE_NAME@$PACKAGE_VERSION" | ||
| echo "🏷️ Tag: ${{ steps.pack.outputs.tag }}" | ||
| echo "🔒 Private field: $PRIVATE_FIELD" | ||
| # Ensure no private field | ||
| if [ "$PRIVATE_FIELD" = "true" ]; then | ||
| echo "❌ Tarball contains private: true - cannot publish" | ||
| exit 1 | ||
| fi | ||
| - name: Publish to npm | ||
| run: | | ||
| # Create .npmrc with auth token | ||
| echo "//registry.npmjs.org/:_authToken=\${NPM_TOKEN}" > .npmrc | ||
| # Publish the tarball with appropriate tag | ||
| npm publish "${{ steps.pack.outputs.tarball }}" --tag "${{ steps.pack.outputs.tag }}" --access public | ||
| env: | ||
| NPM_TOKEN: ${{ secrets.NPM_TOKEN }} | ||
|
There was a problem hiding this comment. We will need to switch this over to Trusted Publishing later. I am tracking that on my side. |
||
| NPM_CONFIG_PROVENANCE: true | ||
|
|
||
| - name: Log success | ||
| run: | | ||
| PACKAGE_NAME=$(tar xfO "${{ steps.pack.outputs.tarball }}" package/package.json | jq -r .name) | ||
| PACKAGE_VERSION=$(tar xfO "${{ steps.pack.outputs.tarball }}" package/package.json | jq -r .version) | ||
| echo "✅ Successfully published $PACKAGE_NAME@$PACKAGE_VERSION to npm with tag ${{ steps.pack.outputs.tag }}" | ||
| echo "📦 Install with: npm install $PACKAGE_NAME@${{ steps.pack.outputs.tag }}" | ||
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
Oops, something went wrong.
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think it's better to extract these out to Actions variables instead of hardcoding, can be a separate improvement PR later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I also would like to see some verification for the downloaded file, like a SHA256 hash or something.