Publish #12
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
| name: Publish | |
| on: | |
| # Only run when manually triggered | |
| workflow_dispatch: | |
| inputs: | |
| versionBump: | |
| description: 'Part of the SemVer project version to bump for release (<major>.<minor>.<patch>)' | |
| required: true | |
| type: choice | |
| options: | |
| - major | |
| - minor | |
| - patch | |
| permissions: | |
| contents: write # read repository content and push updated version and tag | |
| env: | |
| # Enable colored terminal output, see https://doc.rust-lang.org/cargo/reference/config.html#termcolor | |
| CARGO_TERM_COLOR: always | |
| # TODO: Maybe switch to https://github.com/crate-ci/cargo-release in the future, and if possible | |
| # let it check API SemVer compliance, see also https://github.com/crate-ci/cargo-release/issues/62 | |
| jobs: | |
| publish: | |
| runs-on: ubuntu-latest | |
| environment: publishing | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - name: Update project version | |
| shell: bash | |
| # https://github.com/killercup/cargo-edit | |
| run: | | |
| cargo install --no-default-features --features set-version cargo-edit | |
| cargo set-version --bump ${{ inputs.versionBump }} | |
| # There is currently no easy way to get the new version number (see also https://github.com/killercup/cargo-edit/issues/524), | |
| # so have to get it by other means | |
| - name: Get new version | |
| id: get-new-version | |
| shell: bash | |
| # See https://stackoverflow.com/a/75023425 | |
| # and https://docs.github.com/en/actions/using-workflows/workflow-commands-for-github-actions#setting-an-output-parameter | |
| run: | | |
| VERSION=$(cargo metadata --format-version=1 --no-deps | jq --compact-output --raw-output --exit-status '.packages[0].version') | |
| echo "New version: $VERSION" | |
| echo "VERSION=$VERSION" >> $GITHUB_OUTPUT | |
| - name: Commit version update | |
| shell: bash | |
| run: | | |
| git config user.email "41898282+github-actions[bot]@users.noreply.github.com" | |
| git config user.name "github-actions[bot]" | |
| git add . | |
| git commit -m "Release version ${{ steps.get-new-version.outputs.VERSION }}" | |
| git tag -a "v${{ steps.get-new-version.outputs.VERSION }}" -m "Release ${{ steps.get-new-version.outputs.VERSION }}" | |
| - name: Install cargo-make | |
| uses: davidB/rust-cargo-make@10579dcff82285736fad5291533b52d3c93d6b3b | |
| with: | |
| version: '0.37.2' | |
| # Perform full build to make sure there are no issues | |
| - name: Build project | |
| shell: bash | |
| run: cargo make | |
| # TODO: Once this project is more stable, maybe include SemVer checks, e.g. | |
| # https://github.com/rust-lang/rust-semverver or https://github.com/obi1kenobi/cargo-semver-checks | |
| # Clean up results from build to not affect publish in any way | |
| - name: Clean | |
| shell: bash | |
| run: cargo clean | |
| - name: Publish | |
| shell: bash | |
| # TODO: Fail on any warnings (e.g. incorrect Cargo.toml values); not yet available, see https://github.com/rust-lang/cargo/issues/8424 | |
| run: cargo publish --all-features | |
| env: | |
| # CRATES_IO_TOKEN has to be set as GitHub environment secret | |
| CARGO_REGISTRY_TOKEN: ${{ secrets.CRATES_IO_TOKEN }} | |
| - name: Push Git changes | |
| shell: bash | |
| run: git push --follow-tags |