chore: refactor release workflow #3678
+183
−92
There are no files selected for viewing
This file contains 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,97 @@ | ||
| name: "Changesets PR" | ||
|
|
||
| on: | ||
| push: | ||
| branches: | ||
| - master | ||
| - release/* | ||
|
|
||
| concurrency: ${{ github.workflow }}-${{ github.ref }} | ||
|
|
||
| jobs: | ||
| changesets-pr: | ||
| runs-on: ubuntu-latest | ||
| permissions: write-all | ||
| # First check ensures that the workflow runs only if the commit is NOT the changesets PR commit. | ||
| # Second check ensures that the workflow runs only after a commit is pushed into the branch, | ||
| # and not when the branch is created. | ||
| # This is to avoid running the workflow when a release/* branch is created. | ||
| if: | | ||
| github.event.head_commit.message != 'ci(release): versioning packages and changesets' && | ||
| github.event.before != '0000000000000000000000000000000000000000' | ||
|
|
||
| steps: | ||
| - name: Checkout | ||
| uses: actions/checkout@v4 | ||
| with: | ||
| fetch-depth: 0 | ||
| ref: ${{ github.event.pull_request.head.ref }} | ||
|
|
||
| - name: CI Setup | ||
| uses: ./.github/actions/ci-setup | ||
|
|
||
| # if there are changesets present, package.json will be bumped | ||
| - name: Bump and Collect Versions | ||
| run: | | ||
| pnpm changeset version | ||
| echo "RELEASE_VERSION=v$(sed -nE 's/^\s*"version": "(.*?)",$/\1/p' packages/fuels/package.json)" >> $GITHUB_ENV | ||
| echo "FUEL_CORE_VERSION=$(cat ./internal/fuel-core/VERSION)" >> $GITHUB_ENV | ||
| echo "FORC_VERSION=$(cat ./internal/forc/VERSION)" >> $GITHUB_ENV | ||
| git reset --hard | ||
| env: | ||
| GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} | ||
|
|
||
| - name: Set branch name and changeset PR title | ||
| run: | | ||
| echo "CHANGESET_PR_TITLE=$(echo "ci(release): \`${{ env.RELEASE_VERSION }}\` @ \`${{ github.ref_name }}\`")" >> $GITHUB_ENV | ||
|
|
||
| - name: Build | ||
| run: pnpm build | ||
|
|
||
| - name: Create Release Pull Request | ||
| uses: FuelLabs/changesets-action@main | ||
| with: | ||
| version: pnpm changeset:version-with-docs | ||
| commit: "ci(release): versioning packages and changesets" | ||
| title: ${{ env.CHANGESET_PR_TITLE }} | ||
| env: | ||
| GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} | ||
|
|
||
| - name: Prettify changelog | ||
| run: pnpm changeset:update-changelog | ||
| env: | ||
| GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} | ||
| REF_NAME: ${{ github.ref_name }} | ||
| PUBLISHED: "false" | ||
|
|
||
| # # Commenting out as we require permissions to trigger across repos | ||
| # - name: Update docs | ||
| # if: github.ref_name == 'master' | ||
| # uses: benc-uk/workflow-dispatch@v1 | ||
| # with: | ||
| # workflow: update-nightly.yml | ||
| # ref: master | ||
| # repo: FuelLabs/docs-hub | ||
| # token: ${{ secrets.GITHUB_TOKEN }} | ||
|
|
||
| # Upload assets to S3 | ||
| - uses: unfor19/install-aws-cli-action@v1.0.7 | ||
| if: github.ref_name == 'master' | ||
| with: | ||
| version: 2 | ||
| verbose: false | ||
| arch: amd64 | ||
| rootdir: "" | ||
| workdir: "" | ||
|
|
||
| - name: Configure AWS credentials | ||
| uses: aws-actions/configure-aws-credentials@v4 | ||
| if: github.ref_name == 'master' | ||
| with: | ||
| role-to-assume: ${{ vars.AWS_ROLE_ARN }} | ||
| aws-region: ${{ vars.AWS_S3_REGION }} | ||
|
|
||
| - name: Upload assets to s3 | ||
| if: github.ref_name == 'master' | ||
| run: | | ||
| aws s3 cp ./packages/account/src/assets/images/ s3://${{ vars.AWS_S3_BUCKET }}/providers/ --recursive | ||
This file contains 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,62 @@ | ||
| name: "Publish to next tag" | ||
|
|
||
| on: | ||
| push: | ||
| branches: | ||
| - master | ||
|
|
||
| concurrency: ${{ github.workflow }}-${{ github.ref }} | ||
|
|
||
| jobs: | ||
| publish-to-next: | ||
| runs-on: ubuntu-latest | ||
| permissions: write-all | ||
|
|
||
| steps: | ||
| - name: Checkout | ||
| uses: actions/checkout@v4 | ||
| with: | ||
| fetch-depth: 0 | ||
| ref: ${{ github.event.pull_request.head.ref }} | ||
|
|
||
| - name: CI Setup | ||
| uses: ./.github/actions/ci-setup | ||
|
|
||
| - name: Build | ||
| run: pnpm build | ||
|
|
||
| - name: Create .npmrc | ||
| run: | | ||
| cat << EOF > "$HOME/.npmrc" | ||
| //npm.pkg.github.com/:_authToken=$GITHUB_TOKEN | ||
| @FuelLabs:registry=https://npm.pkg.github.com | ||
| EOF | ||
| env: | ||
| HOME: ${{ github.workspace }} | ||
| GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} | ||
|
|
||
| - name: Release to @next tag on GitHub Packages | ||
| run: | | ||
| git checkout master | ||
|
|
||
| CHANGESET_FILE=$(git diff-tree --no-commit-id --name-only HEAD -r ".changeset/*-*-*.md") | ||
| if [ -z "$CHANGESET_FILE" ]; then | ||
| echo "No changesets found, skipping release to @next tag" | ||
| exit 0 | ||
| fi | ||
|
|
||
| AFFECTED_PACKAGES=$(sed -n '/---/,/---/p' "$CHANGESET_FILE" | sed '/---/d') | ||
| if [ -z "$AFFECTED_PACKAGES" ]; then | ||
| echo "No packages affected by changesets, skipping release to @next tag" | ||
| exit 0 | ||
| fi | ||
|
|
||
| pnpm changeset:next | ||
| pnpm changeset version --snapshot next | ||
| pnpm changeset publish --tag next | ||
| env: | ||
| NPM_TOKEN: ${{ secrets.GITHUB_TOKEN }} | ||
| GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} | ||
| NODE_AUTH_TOKEN: ${{ secrets.GITHUB_TOKEN }} | ||
| HOME: ${{ github.workspace }} | ||
| npm_config_registry: "https://npm.pkg.github.com" |
This file contains 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
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 tested this
ifstatement, as well as the one in therelease.yamlfile, in these workflows. I was specifically testing if the workflow will be started or not, and it works as is expected from the logic. If you want to test it yourself, you can create a new branch with a file with this workflow:Commit the file and do the following steps:
git push --set-upstream origin your_branch_name- the workflow won't run because ofgithub.event.before != '0000000000000000000000000000000000000000'git commit --allow-empty -m "ci(release): versioning packages and changesets" && git push- the workflow won't run because the commit message equals'ci(release): versioning packages and changesets'git commit --allow-empty -m "whatever" && git push- the workflow will runThe same holds for the
release.yamlworkflow, just point 2 will succeed and point 3 will fail.