-
-
Notifications
You must be signed in to change notification settings - Fork 465
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge branch 'master' into docs/sphinx-warns-and-errors
- Loading branch information
Showing
4 changed files
with
265 additions
and
17 deletions.
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
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
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,237 @@ | ||
| name: "Release" | ||
|
|
||
| on: | ||
| workflow_dispatch: | ||
| inputs: | ||
| version: | ||
| type: string | ||
| description: "Version number to release (e.g., 1.2.3, 1.2.3-rc1, 1.2.0)" | ||
| required: true | ||
|
|
||
| permissions: write-all | ||
|
|
||
| jobs: | ||
| safety_check: | ||
| runs-on: ubuntu-latest | ||
| environment: release | ||
| env: | ||
| ALLOWED_USER_IDS: ${{ vars.ALLOWED_USER_IDS }} | ||
| steps: | ||
| - name: "Check if Executing User is Allowed" | ||
| id: safety | ||
| run: | | ||
| USER_ID=${{ github.actor_id }} | ||
| ALLOWED_IDS=$(echo $ALLOWED_USER_IDS | tr "," "\n") | ||
| if echo "$ALLOWED_IDS" | grep -q -w "$USER_ID"; then | ||
| echo "User $USER_ID is allowed to run this workflow." | ||
| else | ||
| echo "User $USER_ID is not authorized to run this workflow." | ||
| exit 1 | ||
| fi | ||
| pre_config: | ||
| needs: [safety_check] | ||
| outputs: | ||
| branch_name: ${{ steps.determine_vars.outputs.branch_name }} | ||
| is_rc: ${{ steps.determine_vars.outputs.version }} | ||
| version: ${{ steps.determine_vars.outputs.is_rc }} | ||
| previous_tag: ${{ steps.determine_vars.outputs.previous_tag }} | ||
| runs-on: ububtu-latest | ||
| steps: | ||
| - name: "Checkout Repository" | ||
| uses: actions/checkout@v4 | ||
|
|
||
| - name: "Determine Push Branch" | ||
| id: determine_vars | ||
| run: | | ||
| VERSION=${{ github.event.inputs.version }} | ||
| echo "version=${VERSION}" >> $GITHUB_OUTPUT | ||
| PREVIOUS_TAG=$(git describe --tags --abbrev=0 HEAD^) | ||
| echo "previous_tag=${PREVIOUS_TAG}" >> $GITHUB_OUTPUT | ||
| if [[ $VERSION =~ -rc ]]; then | ||
| MAJOR_MINOR_VERSION=$(echo $VERSION | grep -oE '^[0-9]+\.[0-9]+') | ||
| echo "branch_name=v${MAJOR_MINOR_VERSION}.x" >> $GITHUB_OUTPUT | ||
| echo "is_rc=true" >> $GITHUB_OUTPUT | ||
| elif [[ $VERSION =~ ^[0-9]+\.[0-9]+\.[0-9]+$ ]]; then | ||
| MAJOR_MINOR_VERSION=$(echo $VERSION | grep -oE '^[0-9]+\.[0-9]+') | ||
| echo "branch_name=v${MAJOR_MINOR_VERSION}.x" >> $GITHUB_OUTPUT | ||
| echo "is_rc=false" >> $GITHUB_OUTPUT | ||
| else | ||
| MAJOR_MINOR_VERSION=$(echo $VERSION | grep -oE '^[0-9]+\.[0-9]+') | ||
| echo "branch_name=v${MAJOR_MINOR_VERSION}.x" >> $GITHUB_OUTPUT | ||
| echo "is_rc=false" >> $GITHUB_OUTPUT | ||
| fi | ||
| lib_release: | ||
| needs: [safety_check,pre_config] | ||
| runs-on: ubuntu-latest | ||
| environment: release | ||
| env: | ||
| GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} | ||
| steps: | ||
| - name: "Checkout Repository" | ||
| uses: actions/checkout@v4 | ||
|
|
||
| - name: "Setup Python" | ||
| uses: actions/setup-python@v5 | ||
| with: | ||
| python-version: "3.12" | ||
| cache: "pip" | ||
| cache-dependency-path: "requirements/_release.txt" | ||
|
|
||
| - name: "Install Release Dependencies" | ||
| run: | | ||
| python -m pip install --upgrade pip | ||
| pip install -r requirements/_release.txt | ||
| - name: "Prepare and Update CHANGELOG.md" | ||
| run: | | ||
| VERSION=${{ needs.pre_config.outputs.version }} | ||
| DATE=$(date +'%Y-%m-%d') | ||
| sed -i "s/## \[Unreleased\]/## [$VERSION] - $DATE/" CHANGELOG.md | ||
| sed -i "0,/## \[$VERSION\]/ s|## \[$VERSION\]|## [Unreleased]\n\n### Added\n\n### Changed\n\n### Fixed\n\n### Removed\n\n$&|" CHANGELOG.md | ||
| sed -i "s|\[Unreleased\]:.*|[Unreleased]: https://github.com/Pycord-Development/pycord/compare/v$VERSION...HEAD\n[$VERSION]: https://github.com/Pycord-Development/pycord/compare/v$(git describe --tags --abbrev=0 @^)...v$VERSION|" CHANGELOG.md | ||
| echo "[Unreleased]: https://github.com/Pycord-Development/pycord/compare/v$VERSION...HEAD" >> CHANGELOG.md | ||
| git add CHANGELOG.md | ||
| git commit -m "chore(release): update CHANGELOG for version $VERSION" | ||
| - name: "Commit and Push Changelog to Master" | ||
| run: | | ||
| git config user.name "GitHub Actions" | ||
| git config user.email "[email protected]" | ||
| git add CHANGELOG.md | ||
| git commit -m "chore(release): update CHANGELOG for version ${{ needs.pre_config.outputs.version }}" | ||
| git push origin HEAD:master | ||
| - name: "Push Changelog to Version Branch" | ||
| run: | | ||
| git push origin HEAD:${{ needs.pre_config.outputs.branch_name }} | ||
| - name: "Create Git Tag" | ||
| run: | | ||
| git config user.name "GitHub Actions" | ||
| git config user.email "[email protected]" | ||
| VERSION=${{ needs.pre_config.outputs.version }} | ||
| git tag -s v$VERSION -m "Release version $VERSION" | ||
| git push origin v$VERSION | ||
| - name: "Verify Version" | ||
| run: python -m setuptools_scm | ||
|
|
||
| - name: "Build Package" | ||
| run: | | ||
| python3 -m build --sdist | ||
| python3 -m build --wheel | ||
| - name: "Create GitHub Release" | ||
| uses: softprops/[email protected] | ||
| with: | ||
| tag_name: "v${{ needs.pre_config.outputs.version }}" | ||
| name: "v${{ needs.pre_config.outputs.version }}" | ||
| generate_release_notes: true | ||
| draft: false | ||
| prerelease: ${{ needs.pre_config.outputs.is_rc == 'true' }} | ||
| files: | | ||
| dist/*.whl | ||
| dist/*.tar.gz | ||
| token: ${{ secrets.GITHUB_TOKEN }} | ||
| make_latest: true | ||
|
|
||
| - name: "Publish package distributions to PyPI" | ||
| uses: pypa/[email protected] | ||
| env: | ||
| name: pypi | ||
| url: https://pypi.org/p/pycord | ||
| with: | ||
| password: ${{ secrets.PYPI_TOKEN }} | ||
|
|
||
| docs_release: | ||
| runs-on: ubuntu-latest | ||
| needs: [lib_release,pre_config] | ||
| if: needs.pre_config.outputs.is_rc == 'false' || (needs.pre_config.outputs.is_rc == 'true' && endsWith(needs.pre_config.outputs.version, '.0-rc1')) | ||
| environment: release | ||
| steps: | ||
| - name: "Sync Versions on Read the Docs" | ||
| run: | | ||
| curl --location --request POST 'https://readthedocs.org/api/v3/projects/pycord/sync-versions/' \ | ||
| --header 'Content-Type: application/json' \ | ||
| --header "Authorization: Token ${{ secrets.READTHEDOCS_TOKEN }}" | ||
| - name: "Activate and Show Version on Read the Docs" | ||
| run: | | ||
| VERSION=${{ needs.pre_config.outputs.version }} | ||
| MAJOR_MINOR_VERSION=$(echo $VERSION | grep -oE '^[0-9]+\.[0-9]+') | ||
| PATCH_VERSION=${VERSION##*.} | ||
| if [[ $PATCH_VERSION =~ ^[0-9]+$ ]]; then | ||
| DOCS_VERSION="v$VERSION" | ||
| else | ||
| DOCS_VERSION="v$MAJOR_MINOR_VERSION.x" | ||
| fi | ||
| curl --location --request PATCH "https://readthedocs.org/api/v3/projects/pycord/versions/$DOCS_VERSION/" \ | ||
| --header 'Content-Type: application/json' \ | ||
| --header "Authorization: Token ${{ secrets.READTHEDOCS_TOKEN }}" \ | ||
| --data '{ | ||
| "active": true, | ||
| "hidden": false | ||
| }' | ||
| determine_milestone_id: | ||
| runs-on: ubuntu-latest | ||
| needs: [lib_release,docs_release,pre_config] | ||
| if: ${{ !contains(needs.pre_config.outputs.version, '-') && endsWith(needs.pre_config.outputs.version, '.0') }} | ||
| outputs: | ||
| milestone_version: ${{ steps.extract_version.outputs.milestone_version }} | ||
| environment: release | ||
| steps: | ||
| - name: "Extract Milestone Version" | ||
| id: extract_version | ||
| run: | | ||
| VERSION=${{ needs.pre_config.outputs.version }} | ||
| MILESTONE_VERSION=$(echo $VERSION | grep -oE '^[0-9]+\.[0-9]+') | ||
| echo "milestone_version=$MILESTONE_VERSION" >> $GITHUB_OUTPUT | ||
| close_milestone: | ||
| runs-on: ubuntu-latest | ||
| needs: [determine_milestone_id,pre_config] | ||
| if: ${{ !contains(needs.pre_config.outputs.version, '-') && endsWith(needs.pre_config.outputs.version, '.0') }} | ||
| environment: release | ||
| env: | ||
| GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} | ||
| steps: | ||
| - name: "Close Milestone" | ||
| run: gh milestone edit "v${{ needs.determine_milestone_id.outputs.milestone_version }}" --state closed | ||
|
|
||
| - name: "Create New Milestone" | ||
| run: | | ||
| NEW_MILESTONE_VERSION=$(echo ${{ needs.determine_milestone_id.outputs.milestone_version }} | awk -F. '{print $1"."$2+1}') | ||
| gh milestone create "v${NEW_MILESTONE_VERSION}" | ||
| - name: "Move Open Issues and PRs" | ||
| run: | | ||
| gh issue list --milestone "v${{ needs.determine_milestone_id.outputs.milestone_version }}" --state open | while read issue | ||
| do | ||
| gh issue edit $issue --milestone "v${NEW_MILESTONE_VERSION}" | ||
| done | ||
| inform_discord: | ||
| runs-on: ubuntu-latest | ||
| needs: [lib_release,docs_release,close_milestone,pre_config] | ||
| environment: release | ||
| steps: | ||
| - name: "Notify Discord" | ||
| run: | | ||
| VERSION=${{ needs.pre_config.outputs.version }} | ||
| MAJOR_MINOR_VERSION=$(echo $VERSION | grep -oE '^[0-9]+\.[0-9]+') | ||
| DOCS_URL="<https://docs.pycord.dev/en/v$VERSION/changelog.html>" | ||
| GITHUB_COMPARE_URL="<https://github.com/Pycord-Development/pycord/compare/${{ needs.pre_config.outputs.previous_tag }}...v$VERSION>" | ||
| GITHUB_RELEASE_URL="<https://github.com/Pycord-Development/pycord/releases/tag/v$VERSION>" | ||
| PYPI_RELEASE_URL="<https://pypi.org/project/py-cord/$VERSION/>" | ||
| ANNOUNCEMENT="## <:pycord:1063211537008955495> Pycord v${MAJOR_MINOR_VERSION} is out!\n\n" | ||
| ANNOUNCEMENT="${ANNOUNCEMENT}[@everyone]\n\n" | ||
| ANNOUNCEMENT="${ANNOUNCEMENT}You can view the changelog here: <$DOCS_URL>\n\n" | ||
| ANNOUNCEMENT="${ANNOUNCEMENT}Feel free to take a look at the [GitHub changelog]($GITHUB_COMPARE_URL), [GitHub release page]($GITHUB_RELEASE_URL) and the [PyPI release page]($PYPI_RELEASE_URL).\n\n" | ||
| ANNOUNCEMENT="${ANNOUNCEMENT}You can install this version by running the following command:\n\`\`\`sh\npip install -U py-cord==$VERSION\n\`\`\`\n\n" | ||
| curl -H "Content-Type: application/json" \ | ||
| -X POST \ | ||
| -d "{\"content\":\"$ANNOUNCEMENT\"}" \ | ||
| ${{ secrets.DISCORD_WEBHOOK_URL }} |
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