Skip to content
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

Django: Use current versions of Python #2661

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

cclauss
Copy link
Contributor

@cclauss cclauss commented Dec 8, 2024

https://devguide.python.org/versions/#supported-versions

https://docs.djangoproject.com/en/stable/faq/install/#what-python-version-can-i-use-with-django

Pre-requisites

  • Prior to submitting a new workflow, please apply to join the GitHub Technology Partner Program: partner.github.com/apply.

Please note that at this time we are only accepting new starter workflows for Code Scanning. Updates to existing starter workflows are fine.


Tasks

For all workflows, the workflow:

  • Should be contained in a .yml file with the language or platform as its filename, in lower, kebab-cased format (for example, docker-image.yml). Special characters should be removed or replaced with words as appropriate (for example, "dotnet" instead of ".NET").
  • Should use sentence case for the names of workflows and steps (for example, "Run tests").
  • Should be named only by the name of the language or platform (for example, "Go", not "Go CI" or "Go Build").
  • Should include comments in the workflow for any parts that are not obvious or could use clarification.
  • Should specify least privileged permissions for GITHUB_TOKEN so that the workflow runs successfully.

For CI workflows, the workflow:

  • Should be preserved under the ci directory.
  • Should include a matching ci/properties/*.properties.json file (for example, ci/properties/docker-publish.properties.json).
  • Should run on push to branches: [ $default-branch ] and pull_request to branches: [ $default-branch ].
  • Packaging workflows should run on release with types: [ created ].
  • Publishing workflows should have a filename that is the name of the language or platform, in lower case, followed by "-publish" (for example, docker-publish.yml).

For Code Scanning workflows, the workflow:

  • Should be preserved under the code-scanning directory.
  • Should include a matching code-scanning/properties/*.properties.json file (for example, code-scanning/properties/codeql.properties.json), with properties set as follows:
    • name: Name of the Code Scanning integration.
    • creator: Name of the organization/user producing the Code Scanning integration.
    • description: Short description of the Code Scanning integration.
    • categories: Array of languages supported by the Code Scanning integration.
    • iconName: Name of the SVG logo representing the Code Scanning integration. This SVG logo must be present in the icons directory.
  • Should run on push to branches: [ $default-branch, $protected-branches ] and pull_request to branches: [ $default-branch ]. We also recommend a schedule trigger of cron: $cron-weekly (for example, codeql.yml).

Some general notes:

  • This workflow must only use actions that are produced by GitHub, in the actions organization, or
  • This workflow must only use actions that are produced by the language or ecosystem that the workflow supports. These actions must be published to the GitHub Marketplace. We require that these actions be referenced using the full 40 character hash of the action's commit instead of a tag. Additionally, workflows must include the following comment at the top of the workflow file:
    # This workflow uses actions that are not certified by GitHub.
    # They are provided by a third-party and are governed by
    # separate terms of service, privacy policy, and support
    # documentation.
    
  • Automation and CI workflows should not send data to any 3rd party service except for the purposes of installing dependencies.
  • Automation and CI workflows cannot be dependent on a paid service or product.

@cclauss cclauss requested review from a team as code owners December 8, 2024 01:14
@cclauss cclauss changed the title Use current versions of Python Django: Use current versions of Python Dec 8, 2024
Copy link

@reactive-firewall reactive-firewall left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please see comments inline.

@@ -13,12 +13,12 @@ jobs:
strategy:
max-parallel: 4
matrix:
python-version: [3.7, 3.8, 3.9]
python-version: [3.9, 3.11, 3.13]

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👍 Looks ok; 3.9.20+ through 3.13 are all supported still (3.7 & 3.8 are EoL)!


⚠️ Verification:
Consider continuous versions or clarify new version choice.

NIT @cclauss why `3.9` and `3.11` but no `3.10`, and why skip the default `3.12` in the matrix? This is confusing.

I suggest either:

  • Add both 3.10 and 3.12:
Suggested change
python-version: [3.9, 3.11, 3.13]
python-version: ['3.9', '3.10', '3.11', '3.12' '3.13']
  • Add 3.12 instead of 3.9:
Suggested change
python-version: [3.9, 3.11, 3.13]
python-version: ['3.11', '3.12' '3.13']
  • Keep 3.9 but add 3.10 Instead of 3.13:
Suggested change
python-version: [3.9, 3.11, 3.13]
python-version: ['3.9', '3.10', '3.11'] # 3.12 is already installed by default on ubuntu-latest

Important

while perfectly fine for versions pre-3.10 (e.g. 3.9), the github yaml parsing seems to prefer quoted values (e.g. as in python-package.yml) than raw Semantic-Versions (e.g. 🙅 3.11). If these are the intended versions (see previous consideration), then I'd recommend quoting them for consistency.

Suggested change
python-version: [3.9, 3.11, 3.13]
python-version: ["3.9", "3.11", "3.13"]

Copy link
Contributor Author

@cclauss cclauss Dec 14, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The first comment above merely reiterates what is in the URLs in the commit message.

Continuous versions is not an advantage. Coverage is an advantage. If tests pass on Py39, Py311, and Py313 then the chances are very high that Py310 and Py312 will also pass. The setup and running of tests on 5 platforms takes more energy and creates more greenhouse gases than 3 for a negligible benefit. This PR does not want to be more consumptive than the code that it replaces.

If yaml does not need the quotes then yaml does not need the quotes.

uses: actions/setup-python@v3
uses: actions/setup-python@v5

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This change @v3 --> @v5 LGTM!

Copy link

@reactive-firewall reactive-firewall left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👍 LGTM!

  • 3.9.20+ through 3.13 are all supported still (3.7 & 3.8 are EoL)! (as already documented by @cclauss).
  • All questions raised in my initial review have been answered. (@cclauss Thanks for clarifying 🙇)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants