jazzband -> django-commons updates#883
Merged
Merged
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
Updates project references and automation to reflect the move from Jazzband to django-commons, including release and Code of Conduct maintenance workflows.
Changes:
- Replace
jazzband/django-polymorphiclinks withdjango-commons/django-polymorphicacross project metadata and documentation. - Update GitHub Actions release workflow to use trusted publishing (PyPI/TestPyPI) and add Sigstore signing + GitHub Releases.
- Add a scheduled workflow to keep
CODE_OF_CONDUCT.mdin sync with the django-commons membership repository.
Reviewed changes
Copilot reviewed 10 out of 10 changed files in this pull request and generated 10 comments.
Show a summary per file
| File | Description |
|---|---|
pyproject.toml |
Updates repository/URL metadata to django-commons and points CoC URL to django-commons membership. |
docs/managers.rst |
Updates discussion link to new org/repo. |
docs/deletion.rst |
Updates issues link to new org/repo. |
docs/changelog/index.rst |
Updates historical issue/PR/release links to new org/repo. |
docs/advanced.rst |
Updates PR link to new org/repo within fixture guidance. |
SECURITY.md |
Updates workflow badges and private advisory link to new org/repo. |
README.md |
Updates CI/badges for new org and replaces Jazzband badge with django-commons badge. |
CONTRIBUTING.md |
Removes Jazzband framing and updates contributor guidance text. |
.github/workflows/update_coc.yml |
Adds scheduled workflow to sync Code of Conduct from django-commons membership repo. |
.github/workflows/release.yml |
Migrates release process away from Jazzband upload to trusted publishing + signing + GitHub release creation. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Comment on lines
92
to
+104
| runs-on: ubuntu-latest | ||
| permissions: {} # only needs JAZZBAND_RELEASE_KEY secret, no GitHub token scopes | ||
| environment: | ||
| name: pypi | ||
| url: https://pypi.org/p/${{ needs.build.outputs.PACKAGE_NAME }} | ||
| permissions: | ||
| id-token: write # IMPORTANT: mandatory for trusted publishing | ||
| steps: | ||
| - name: Download all the dists | ||
| uses: actions/download-artifact@3e5f45b2cfb9172054b4087a40e8e0b5a5461e7c | ||
| with: | ||
| name: python-package-distributions | ||
| path: dist/ | ||
| - name: Upload Package to Jazzband | ||
| uses: pypa/gh-action-pypi-publish@ed0c53931b1dc9bd32cbe73a98c7f6766f8a527e | ||
| with: | ||
| user: jazzband | ||
| password: ${{ secrets.JAZZBAND_RELEASE_KEY }} | ||
| attestations: false | ||
| repository-url: https://jazzband.co/projects/django-polymorphic/upload | ||
| verbose: true | ||
| - name: Download all the dists | ||
| uses: actions/download-artifact@3e5f45b2cfb9172054b4087a40e8e0b5a5461e7c | ||
| with: | ||
| name: python-package-distributions | ||
| path: dist/ | ||
| - name: Publish distribution 📦 to PyPI |
Comment on lines
114
to
+123
| permissions: | ||
| contents: write # IMPORTANT: mandatory for making GitHub Releases | ||
| id-token: write # IMPORTANT: mandatory for sigstore | ||
| contents: write # IMPORTANT: mandatory for making GitHub Releases | ||
| id-token: write # IMPORTANT: mandatory for sigstore | ||
|
|
||
| steps: | ||
| - name: Download all the dists | ||
| uses: actions/download-artifact@3e5f45b2cfb9172054b4087a40e8e0b5a5461e7c | ||
| with: | ||
| name: python-package-distributions | ||
| path: dist/ |
|
|
||
| - name: Fetch CODE_OF_CONDUCT.md from django-commons | ||
| run: | | ||
| curl -o fetched_code_of_conduct.md https://raw.githubusercontent.com/django-commons/membership/main/CODE_OF_CONDUCT.md |
| @@ -143,7 +143,7 @@ commands just as regular models do. There are two important considerations: | |||
|
|
|||
| 1. Polymorphic models are multi-table models and :django-admin:`dumpdata` serializes each table | |||
| separately. :pypi:`django-polymorphic` `does it's best | |||
| * Fix missing ``history_view()`` redirection to the child admin, which is important for | ||
| django-reversion_ support. See the documentation for hints for | ||
| `django-reversion-compare support <https://github.com/jazzband/django-polymorphic/discussions/831>_`. | ||
| `django-reversion-compare support <https://github.com/django-commons/django-polymorphic/discussions/831>_`. |
|
|
||
| We are actively seeking additional maintainers. If you're interested, [contact me](https://github.com/bckohan). | ||
| We are actively seeking additional maintainers. If you're interested, please open an issue or [contact me](https://github.com/bckohan). | ||
|
|
Comment on lines
+81
to
+83
| run: | ||
| PACKAGE_NAME=$(python -c "import tomllib; print(tomllib.load(open('pyproject.toml', 'rb'))['project']['name'])") | ||
| echo "PACKAGE_NAME=${PACKAGE_NAME}" >> $GITHUB_ENV |
Comment on lines
36
to
38
| outputs: | ||
| PACKAGE_NAME: ${{ steps.set-package.outputs.package_name }} | ||
| RELEASE_VERSION: ${{ steps.set-package.outputs.release_version }} |
Comment on lines
+159
to
+172
| environment: | ||
| name: testpypi | ||
| url: https://test.pypi.org/project/${{ needs.build.outputs.PACKAGE_NAME }} | ||
|
|
||
| permissions: | ||
| id-token: write # IMPORTANT: mandatory for trusted publishing | ||
|
|
||
| steps: | ||
| - name: Download all the dists | ||
| uses: actions/download-artifact@3e5f45b2cfb9172054b4087a40e8e0b5a5461e7c | ||
| with: | ||
| name: python-package-distributions | ||
| path: dist/ | ||
| - name: Sign the dists with Sigstore | ||
| uses: sigstore/gh-action-sigstore-python@04cffa1d795717b140764e8b640de88853c92acc | ||
| with: | ||
| inputs: >- | ||
| ./dist/*.tar.gz | ||
| ./dist/*.whl | ||
| - name: Create GitHub Release | ||
| env: | ||
| GITHUB_TOKEN: ${{ github.token }} | ||
| GITHUB_REF_NAME: ${{ github.ref_name }} | ||
| GITHUB_REPOSITORY: ${{ github.repository }} | ||
| run: >- | ||
| gh release create | ||
| "$GITHUB_REF_NAME" | ||
| --repo "$GITHUB_REPOSITORY" | ||
| --generate-notes | ||
| - name: Upload artifact signatures to GitHub Release | ||
| env: | ||
| GITHUB_TOKEN: ${{ github.token }} | ||
| GITHUB_REF_NAME: ${{ github.ref_name }} | ||
| GITHUB_REPOSITORY: ${{ github.repository }} | ||
| # Upload to GitHub Release using the `gh` CLI. | ||
| # `dist/` contains the built packages, and the | ||
| # sigstore-produced signatures and certificates. | ||
| run: >- | ||
| gh release upload | ||
| "$GITHUB_REF_NAME" dist/** | ||
| --repo "$GITHUB_REPOSITORY" | ||
| - name: Download all the dists | ||
| uses: actions/download-artifact@3e5f45b2cfb9172054b4087a40e8e0b5a5461e7c | ||
| with: | ||
| name: python-package-distributions | ||
| path: dist/ | ||
| - name: Publish distribution 📦 to TestPyPI |
| RELEASE_VERSION=$(just validate_version $TAG_NAME) | ||
|
|
||
| # export the release version | ||
| echo "RELEASE_VERSION=${RELEASE_VERSION}" >> $GITHUB_ENV |
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Changes needed for the move into django-commons