Repository navigation
Modernize Python tooling (pyproject.toml, uv, python-semantic-release) #328
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
base: master
Are you sure you want to change the base?
Changes from all commits
fe74ad4
bf9670a
e910450
5bcce58
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
This file was deleted.
This file was deleted.
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,151 @@ | ||
| name: Semantic Release | ||
|
|
||
| on: | ||
| push: | ||
| branches: [master] | ||
| # Run manually on an older branch to cut a patch release for that line. | ||
|
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Adding it seems fine to me.
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I've kept it. It mirrors the current |
||
| workflow_dispatch: | ||
| inputs: | ||
| force: | ||
| description: 'Force a version bump (auto = derive from commits)' | ||
| type: choice | ||
| options: [auto, patch, minor, major] | ||
| default: auto | ||
|
|
||
| jobs: | ||
| # The same aggregate a pull request has to pass, so the release runs exactly | ||
| # the checks that were required to merge -- and picks up any package added to | ||
| # ci.yml later without needing a change here. | ||
| run_ci: | ||
| uses: ./.github/workflows/ci.yml | ||
|
|
||
| release: | ||
| # The package this workflow publishes has to build before we tag | ||
| # anything. The GitHub release and the PyPI upload cannot be taken back, | ||
| # so a package that only fails to build in its publish job would leave the | ||
| # release half-finished. | ||
| needs: [run_ci] | ||
| runs-on: ubuntu-latest | ||
| concurrency: | ||
| group: ${{ github.workflow }}-release-${{ github.ref_name }} | ||
| cancel-in-progress: false | ||
|
|
||
| permissions: | ||
| contents: write | ||
|
|
||
| steps: | ||
| # Note: We checkout the repository at the branch that triggered the workflow. | ||
| # Python Semantic Release will automatically convert shallow clones to full clones | ||
| # if needed to ensure proper history evaluation. However, we forcefully reset the | ||
| # branch to the workflow sha because it is possible that the branch was updated | ||
| # while the workflow was running, which prevents accidentally releasing un-evaluated | ||
| # changes. | ||
| - name: Setup | Checkout Repository on Release Branch | ||
| uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1 | ||
| with: | ||
| ref: ${{ github.ref_name }} | ||
|
|
||
| - name: Setup | Force release branch to be at workflow sha | ||
| run: | | ||
| git reset --hard ${{ github.sha }} | ||
|
|
||
| - name: Action | Semantic Version Release | ||
| id: release | ||
| # Adjust tag with desired version if applicable. | ||
| uses: python-semantic-release/python-semantic-release@b700dbeb1f431a0fcc30a79f3f0869407fe07278 # v10.7.0 | ||
| with: | ||
| github_token: ${{ secrets.GITHUB_TOKEN }} | ||
| git_committer_name: "github-actions" | ||
| git_committer_email: "[email protected]" | ||
| changelog: "false" | ||
| # Commit, tag, push and build, but don't create the GitHub release. | ||
| # We create it ourselves in the next step so that the distributions | ||
| # are attached before the release is published. See that step for why. | ||
| vcs_release: "false" | ||
| force: ${{ inputs.force != 'auto' && inputs.force || '' }} | ||
|
|
||
| # python-semantic-release exits successfully without releasing when the | ||
| # branch is not in a release group or there is nothing to release. A | ||
| # manual run is always meant to release, so fail it rather than show it | ||
| # as green. | ||
| - name: Check | Fail a manual run that released nothing | ||
| if: github.event_name == 'workflow_dispatch' && steps.release.outputs.released != 'true' | ||
| run: | | ||
| echo "::error::No release was made. Run this on master or release/<name>, with releasable commits." | ||
| exit 1 | ||
|
|
||
| # python-semantic-release also skips the release, and exits successfully, | ||
| # when the next version is already tagged on another branch, eg. main's | ||
| # next minor taken by a release branch. Fail so the skip doesn't look green. | ||
| - name: Check | Fail when the next version is tagged on another branch | ||
| if: steps.release.outputs.released != 'true' | ||
| env: | ||
| TAG: ${{ steps.release.outputs.tag }} | ||
| run: | | ||
| git fetch --tags --quiet | ||
| if git rev-parse -q --verify "refs/tags/$TAG" >/dev/null \ | ||
| && ! git merge-base --is-ancestor "$TAG" HEAD; then | ||
| echo "::error::$TAG is already tagged on another branch, so this release was skipped." | ||
| exit 1 | ||
| fi | ||
|
|
||
| # This repo has immutable releases enabled, which freezes a release's | ||
| # assets the moment it is published, so assets cannot be attached | ||
| # afterwards. Everything we want on the release has to be built by now | ||
| # and passed to this one command, which creates the release as a draft, | ||
| # uploads the assets, and only then publishes it: | ||
| # https://docs.github.com/en/code-security/supply-chain-security/understanding-your-software-supply-chain/immutable-releases | ||
| - name: Publish | Create GitHub Release with Assets | ||
| if: steps.release.outputs.released == 'true' | ||
| env: | ||
| GH_TOKEN: ${{ secrets.GITHUB_TOKEN }} | ||
| # Reuse the release notes python-semantic-release generated for us. | ||
| RELEASE_NOTES: ${{ steps.release.outputs.release_notes }} | ||
| TAG: ${{ steps.release.outputs.tag }} | ||
| run: | | ||
| # Output the release notes to a file | ||
| printf '%s' "$RELEASE_NOTES" > "$RUNNER_TEMP/release_notes.md" | ||
| # Creates the release as a draft, uploads the assets, and then | ||
| # publishes it -- all within this one command. | ||
| gh release create "$TAG" \ | ||
| --verify-tag \ | ||
| --latest=${{ github.ref_name == 'master' }} \ | ||
| --title "$TAG" \ | ||
| --notes-file "$RUNNER_TEMP/release_notes.md" \ | ||
| dist/* | ||
|
|
||
| - name: Upload | Distribution Artifacts | ||
| uses: actions/upload-artifact@cf430e030ddbb5b0abf93d22962f4752f3646cd9 # v7.0.2 | ||
| if: steps.release.outputs.released == 'true' | ||
| with: | ||
| name: distribution-artifacts | ||
| path: dist | ||
| if-no-files-found: error | ||
|
|
||
| outputs: | ||
| released: ${{ steps.release.outputs.released || 'false' }} | ||
| version: ${{ steps.release.outputs.version }} | ||
|
|
||
| publish_to_pypi: | ||
| # 1. Separate out the publish step from the github release step to run each step at | ||
| # the least amount of token privilege | ||
| # 2. Also, publishing can fail, and its better to have a separate job if you need to retry | ||
| # and it won't require reversing the release. | ||
| runs-on: ubuntu-latest | ||
| needs: release | ||
| if: needs.release.outputs.released == 'true' | ||
|
|
||
| permissions: | ||
| contents: read | ||
| id-token: write | ||
|
|
||
| steps: | ||
| - name: Setup | Download Build Artifacts | ||
| uses: actions/download-artifact@9000827ccba6bdab643e8b6fd33ac0654aef8333 # v8.0.2 | ||
| id: artifact-download | ||
| with: | ||
| name: distribution-artifacts | ||
| path: dist | ||
|
|
||
| - name: Publish to PyPi | ||
| uses: pypa/gh-action-pypi-publish@7245906fb61fa33a13554f9d5fb856fe61758086 # v1.14.3 | ||
| Original file line number | Diff line number | Diff line change | ||||||||
|---|---|---|---|---|---|---|---|---|---|---|
|
|
@@ -2,8 +2,10 @@ include LICENSE | |||||||||
| include README.rst | ||||||||||
|
|
||||||||||
| recursive-include src/cc2olx/templates * | ||||||||||
| recursive-include requirements * | ||||||||||
| recursive-include tests * | ||||||||||
| prune test_data | ||||||||||
|
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. The sdist now picks up every tracked file (uv.lock, .github/, Dockerfile, etc.; 309 KB → 366 KB). Exclude them?
Suggested change
Also,
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Done in 5bcce58, using your excludes as written. The sdist is back to 310 KB. Compared with master's sdist, the only files that dropped out are |
||||||||||
| prune .github | ||||||||||
| exclude uv.lock Dockerfile .dockerignore .editorconfig .gitignore codecov.yml | ||||||||||
| recursive-exclude * __pycache__ | ||||||||||
| recursive-exclude * *.py[co] | ||||||||||
|
|
||||||||||
|
|
||||||||||
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.
With
workflow_callfromrelease.yml, thepush:trigger makes CI run twice on every merge. Same fix as openedx/forum#293:.github/workflows/ci.yml:3and point the badge at release.yml:
README.rst:4There 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.
Done in 5bcce58: dropped
push:and pointed the badge atrelease.yml. The live sample-pluginci.ymlalso has onlypull_requestandworkflow_callnow.