Repository navigation
Add release workflow #141
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
Merged
Merged
Add release workflow #141
Changes from all commits
Commits
Show all changes
4 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,156 @@ | ||
| # Publishes the release drafted by draft-release.yml. Runs when the release PR lands on main | ||
| # (or manually, as a fallback / dry run): detects the pending draft from CHANGELOG.md, tests and | ||
| # builds the gem without any publishing rights, then pushes the built gem to RubyGems from the | ||
| # `release` environment and un-drafts the GitHub Release, which creates the tag. | ||
| name: Release | ||
| on: | ||
| push: | ||
| branches: [main] | ||
| paths: [CHANGELOG.md] | ||
| workflow_dispatch: | ||
| inputs: | ||
| dry_run: | ||
| description: "Dry run: detect the release, test and build the gem, but do not publish" | ||
| required: false | ||
| type: boolean | ||
| default: false | ||
|
|
||
| concurrency: | ||
| group: ${{ github.workflow }} | ||
| cancel-in-progress: false | ||
|
|
||
| permissions: | ||
| contents: read | ||
|
|
||
| jobs: | ||
| detect: | ||
| name: Detect pending release | ||
| runs-on: ubuntu-latest | ||
| outputs: | ||
| version: ${{ steps.pending.outputs.version }} | ||
| tag: ${{ steps.pending.outputs.tag }} | ||
| go: ${{ steps.decide.outputs.go }} | ||
| steps: | ||
| - name: Refuse to release from a non-default branch | ||
| env: | ||
| REF: ${{ github.ref }} | ||
| DEFAULT_BRANCH: ${{ github.event.repository.default_branch }} | ||
| run: | | ||
| if [ "$REF" != "refs/heads/$DEFAULT_BRANCH" ]; then | ||
| echo "::error::Releases must run from $DEFAULT_BRANCH, got $REF" | ||
| exit 1 | ||
| fi | ||
|
|
||
| - uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1 | ||
| with: | ||
| persist-credentials: false | ||
|
|
||
| - name: Resolve pending release | ||
| id: pending | ||
| uses: railsware/github-actions/resolve-pending-release@master | ||
|
IgorDobryn marked this conversation as resolved.
Resolved
|
||
|
|
||
| # push: skip quietly when nothing is pending (an ordinary CHANGELOG edit). | ||
| # dispatch: a real run needs an unreleased version; a dry run doesn't. detect can't see drafts | ||
| # (read-only token), so the publish job confirms the draft after approval. | ||
| - name: Decide | ||
| id: decide | ||
| env: | ||
| EVENT: ${{ github.event_name }} | ||
| PENDING: ${{ steps.pending.outputs.pending }} | ||
| DRY_RUN: ${{ inputs.dry_run }} | ||
| run: | | ||
| echo "pending=$PENDING dry_run=$DRY_RUN" | ||
| if [ "$DRY_RUN" = "true" ] && [ "$PENDING" != "true" ]; then | ||
| echo "::warning::The top CHANGELOG.md version is already released, so this dry run doesn't exercise detection" | ||
| fi | ||
| if [ "$PENDING" = "true" ] || [ "$DRY_RUN" = "true" ]; then | ||
| echo "go=true" >> "$GITHUB_OUTPUT" | ||
| elif [ "$EVENT" = "workflow_dispatch" ]; then | ||
| echo "::error::The top CHANGELOG.md version is already released; run Draft ruby Release first" | ||
| exit 1 | ||
| else | ||
| echo "Nothing to release" | ||
| echo "go=false" >> "$GITHUB_OUTPUT" | ||
| fi | ||
|
|
||
| build: | ||
| name: Test and build | ||
| needs: detect | ||
| if: needs.detect.outputs.go == 'true' | ||
| runs-on: ubuntu-latest | ||
| steps: | ||
| # The gemspec lists files with `git ls-files`, so the checkout keeps its .git directory. | ||
| - uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1 | ||
| with: | ||
| persist-credentials: false | ||
|
|
||
| - uses: ruby/setup-ruby@7f797815d8adceb1c412e7abefdd1ab4abc47a5f # v1.335.0 | ||
| with: | ||
| ruby-version: '3.3' | ||
| bundler-cache: false | ||
|
|
||
| - name: Check version file matches CHANGELOG.md | ||
| env: | ||
| EXPECTED: ${{ needs.detect.outputs.version }} | ||
| run: | | ||
| actual=$(ruby -r ./lib/mailtrap/version.rb -e 'puts Mailtrap::VERSION') | ||
| if [ "$actual" != "$EXPECTED" ]; then | ||
| echo "::error::Mailtrap::VERSION is $actual but CHANGELOG.md is $EXPECTED" | ||
| exit 1 | ||
| fi | ||
|
|
||
| - name: Install, test, build | ||
| run: | | ||
| bundle install | ||
| bundle exec rspec | ||
| gem build mailtrap.gemspec | ||
| mkdir dist && mv mailtrap-*.gem dist/ | ||
|
|
||
| - uses: actions/upload-artifact@cf430e030ddbb5b0abf93d22962f4752f3646cd9 # v7.0.2 | ||
| with: | ||
| name: gem | ||
| path: dist/ | ||
| if-no-files-found: error | ||
|
|
||
| release: | ||
| name: Publish | ||
| needs: [detect, build] | ||
| if: ${{ !inputs.dry_run }} | ||
| runs-on: ubuntu-latest | ||
| environment: release | ||
| permissions: | ||
| contents: write # edit and un-draft the release | ||
| id-token: write # RubyGems trusted publishing | ||
| steps: | ||
| - uses: actions/download-artifact@9000827ccba6bdab643e8b6fd33ac0654aef8333 # v8.0.2 | ||
| with: | ||
| name: gem | ||
| path: dist/ | ||
|
|
||
| - uses: ruby/setup-ruby@7f797815d8adceb1c412e7abefdd1ab4abc47a5f # v1.335.0 | ||
| with: | ||
| ruby-version: '3.3' | ||
| bundler: none | ||
|
|
||
| - name: Check RubyGems release | ||
| uses: railsware/github-actions/check-sdk-rubygems-release@master | ||
| with: | ||
| gem: mailtrap | ||
| version: ${{ needs.detect.outputs.version }} | ||
|
|
||
| - name: Check GitHub release | ||
| uses: railsware/github-actions/check-sdk-github-release@master | ||
| with: | ||
| tag: ${{ needs.detect.outputs.tag }} | ||
|
|
||
| - uses: rubygems/configure-rubygems-credentials@dc5a8d8553e6ee01fc26761a49e99e733d17954a # v2.1.0 | ||
|
|
||
| # Pushing the built gem runs none of its code, so nothing from the dependency tree runs here. | ||
| - name: Publish to RubyGems | ||
| run: gem push dist/*.gem | ||
|
|
||
| - name: Publish GitHub release | ||
| uses: railsware/github-actions/publish-github-release@master | ||
| with: | ||
| tag: ${{ needs.detect.outputs.tag }} | ||
| target: ${{ github.sha }} | ||
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.
Uh oh!
There was an error while loading. Please reload this page.