Create a release #30
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: Create a release | |
| on: | |
| # Trigger a stable version release via GitHub's UI, with the ability to specify the type of release. | |
| workflow_dispatch: | |
| inputs: | |
| release_type: | |
| description: Release type | |
| required: true | |
| type: choice | |
| default: auto | |
| options: | |
| - auto | |
| - custom | |
| - patch | |
| - minor | |
| - major | |
| custom_version: | |
| description: The custom version to bump to (only for "custom" type) | |
| required: false | |
| type: string | |
| default: "" | |
| concurrency: | |
| group: release | |
| cancel-in-progress: false | |
| jobs: | |
| release_metadata: | |
| name: Prepare release metadata | |
| runs-on: ubuntu-latest | |
| outputs: | |
| version_number: ${{ steps.release_metadata.outputs.version_number }} | |
| tag_name: ${{ steps.release_metadata.outputs.tag_name }} | |
| changelog: ${{ steps.release_metadata.outputs.changelog }} | |
| release_notes: ${{ steps.release_metadata.outputs.release_notes }} | |
| steps: | |
| - uses: apify/workflows/git-cliff-release@main | |
| name: Prepare release metadata | |
| id: release_metadata | |
| with: | |
| release_type: ${{ inputs.release_type }} | |
| custom_version: ${{ inputs.custom_version }} | |
| existing_changelog_path: CHANGELOG.md | |
| # If github.ref points to a [skip ci] commit, we assume that it was added by the pre_release workflow, | |
| # which doesn't push the commit if code checks don't pass. | |
| # Otherwise, the checks will have been triggered by the `run_code_checks` workflow. | |
| wait_for_checks: | |
| name: Wait for code checks to pass | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: Checkout repository | |
| uses: actions/checkout@v4 | |
| - name: Check if the head commit contains [skip ci] | |
| id: check_skip | |
| run: | | |
| if git log --format=%B -n 1 ${{ github.sha }} | head -n 1 | grep '\[skip ci\]$'; then | |
| echo 'skipped=true' >> $GITHUB_OUTPUT | |
| else | |
| echo 'skipped=false' >> $GITHUB_OUTPUT | |
| fi | |
| - uses: lewagon/wait-on-check-action@v1.3.4 | |
| if: ${{ steps.check_skip.outputs.skipped == 'false' }} | |
| with: | |
| ref: ${{ github.ref }} | |
| repo-token: ${{ secrets.GITHUB_TOKEN }} | |
| check-regexp: "( check| tests)$" | |
| wait-interval: 5 | |
| update_changelog: | |
| name: Update changelog | |
| needs: [release_metadata, wait_for_checks] | |
| uses: apify/workflows/.github/workflows/python_bump_and_update_changelog.yaml@main | |
| with: | |
| version_number: ${{ needs.release_metadata.outputs.version_number }} | |
| changelog: ${{ needs.release_metadata.outputs.changelog }} | |
| secrets: | |
| APIFY_SERVICE_ACCOUNT_GITHUB_TOKEN: ${{ secrets.APIFY_SERVICE_ACCOUNT_GITHUB_TOKEN }} | |
| build_and_deploy_docs: | |
| needs: [update_changelog] | |
| uses: ./.github/workflows/build_and_deploy_docs.yaml | |
| with: | |
| ref: ${{ needs.update_changelog.outputs.changelog_commitish }} | |
| secrets: inherit | |
| create_github_release: | |
| name: Create github release | |
| needs: [release_metadata, update_changelog] | |
| runs-on: ubuntu-latest | |
| env: | |
| GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} | |
| steps: | |
| - name: Create release | |
| uses: softprops/action-gh-release@v2 | |
| with: | |
| tag_name: ${{ needs.release_metadata.outputs.tag_name }} | |
| name: ${{ needs.release_metadata.outputs.version_number }} | |
| target_commitish: ${{ needs.update_changelog.outputs.changelog_commitish }} | |
| body: ${{ needs.release_metadata.outputs.release_notes }} | |
| publish_to_pypi: | |
| name: Publish to PyPI | |
| needs: [release_metadata, update_changelog] | |
| runs-on: ubuntu-latest | |
| permissions: | |
| contents: write | |
| id-token: write # Required for OIDC authentication. | |
| environment: | |
| name: pypi | |
| url: https://pypi.org/project/crawlee | |
| steps: | |
| - name: Prepare distribution | |
| uses: apify/workflows/prepare-pypi-distribution@main | |
| with: | |
| package_name: crawlee | |
| is_prerelease: "" | |
| version_number: ${{ needs.release_metadata.outputs.version_number }} | |
| ref: ${{ needs.update_changelog.outputs.changelog_commitish }} | |
| # Publishes the package to PyPI using PyPA official GitHub action with OIDC authentication. | |
| - name: Publish package to PyPI | |
| uses: pypa/gh-action-pypi-publish@release/v1 | |
| # TODO: add job for publish package to Conda | |
| # https://github.com/apify/crawlee-python/issues/104 |