-
Notifications
You must be signed in to change notification settings - Fork 687
Improve wording and "fix example" (remove 3.13) on testing against pre-release #979
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
Conversation
…e-releases 3.13 was added in a mass tune up in 0b93645 , without adjusting the wording. With 3.13 listed there too, example does not really make much sense. So I decided to make it explicit in wording and remove 3.13, so whenever next refactoring to add 3.14 to be added to every line where 3.13 is -- this would not even come to attention
|
Hi @yarikoptic, thanks for improving the documentation! |
|
Since here I am not adding a new documentation but rather providing minor tune up to already existing wording, which was potentially added when |
|
Hi @yarikoptic, To keep the original wording intact, it is suggested to only update the version number from 3.12 to 3.14 in the paragraph, like this:
And in the matrix, update the version list to: This way, the example provides a concrete and current reference for configuring workflows with a real pre-release version, making it more practical and helpful for users. |
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.
Pull Request Overview
This PR improves the documentation for the allow-prereleases feature by updating the example to use Python 3.14 instead of 3.13, making the pre-release scenario more realistic since 3.13 is now generally available.
- Updates example version from 3.13 to 3.14 to better illustrate pre-release behavior
- Adjusts wording to clarify this is a historical example of how the feature would work
- Simplifies the matrix to focus on the single pre-release version being demonstrated
Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.
| matrix: | ||
| os: [Ubuntu, Windows, macOS] | ||
| python_version: ["3.11", "3.12", "3.13"] | ||
| python_version: ["3.14"] |
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.
@gowridurgad like this?
if you see how to improve further, please use suggestions

so we converge faster.
Bumps [actions/setup-python](https://github.com/actions/setup-python) from 6.0.0 to 6.1.0. Release notes *Sourced from [actions/setup-python's releases](https://github.com/actions/setup-python/releases).* > v6.1.0 > ------ > > What's Changed > -------------- > > ### Enhancements: > > * Add support for `pip-install` input by [`@gowridurgad`](https://github.com/gowridurgad) in [actions/setup-python#1201](https://redirect.github.com/actions/setup-python/pull/1201) > * Add graalpy early-access and windows builds by [`@timfel`](https://github.com/timfel) in [actions/setup-python#880](https://redirect.github.com/actions/setup-python/pull/880) > > ### Dependency and Documentation updates: > > * Enhanced wording and updated example usage for `allow-prereleases` by [`@yarikoptic`](https://github.com/yarikoptic) in [actions/setup-python#979](https://redirect.github.com/actions/setup-python/pull/979) > * Upgrade urllib3 from 1.26.19 to 2.5.0 and document breaking changes in v6 by [`@dependabot`](https://github.com/dependabot) in [actions/setup-python#1139](https://redirect.github.com/actions/setup-python/pull/1139) > * Upgrade typescript from 5.4.2 to 5.9.3 and Documentation update by [`@dependabot`](https://github.com/dependabot) in [actions/setup-python#1094](https://redirect.github.com/actions/setup-python/pull/1094) > * Upgrade actions/publish-action from 0.3.0 to 0.4.0 & Documentation update for pip-install input by [`@dependabot`](https://github.com/dependabot) in [actions/setup-python#1199](https://redirect.github.com/actions/setup-python/pull/1199) > * Upgrade requests from 2.32.2 to 2.32.4 by [`@dependabot`](https://github.com/dependabot) in [actions/setup-python#1130](https://redirect.github.com/actions/setup-python/pull/1130) > * Upgrade prettier from 3.5.3 to 3.6.2 by [`@dependabot`](https://github.com/dependabot) in [actions/setup-python#1234](https://redirect.github.com/actions/setup-python/pull/1234) > * Upgrade `@types/node` from 24.1.0 to 24.9.1 and update macos-13 to macos-15-intel by [`@dependabot`](https://github.com/dependabot) in [actions/setup-python#1235](https://redirect.github.com/actions/setup-python/pull/1235) > > New Contributors > ---------------- > > * [`@yarikoptic`](https://github.com/yarikoptic) made their first contribution in [actions/setup-python#979](https://redirect.github.com/actions/setup-python/pull/979) > > **Full Changelog**: <actions/setup-python@v6...v6.1.0> Commits * [`83679a8`](actions/setup-python@83679a8) Bump `@types/node` from 24.1.0 to 24.9.1 and update macos-13 to macos-15-intel ... * [`bfc4944`](actions/setup-python@bfc4944) Bump prettier from 3.5.3 to 3.6.2 ([#1234](https://redirect.github.com/actions/setup-python/issues/1234)) * [`97aeb3e`](actions/setup-python@97aeb3e) Bump requests from 2.32.2 to 2.32.4 in /**tests**/data ([#1130](https://redirect.github.com/actions/setup-python/issues/1130)) * [`443da59`](actions/setup-python@443da59) Bump actions/publish-action from 0.3.0 to 0.4.0 & Documentation update for pi... * [`cfd55ca`](actions/setup-python@cfd55ca) graalpy: add graalpy early-access and windows builds ([#880](https://redirect.github.com/actions/setup-python/issues/880)) * [`bba65e5`](actions/setup-python@bba65e5) Bump typescript from 5.4.2 to 5.9.3 and update docs/advanced-usage.md ([#1094](https://redirect.github.com/actions/setup-python/issues/1094)) * [`18566f8`](actions/setup-python@18566f8) Improve wording and "fix example" (remove 3.13) on testing against pre-releas... * [`2e3e4b1`](actions/setup-python@2e3e4b1) Add support for pip-install input ([#1201](https://redirect.github.com/actions/setup-python/issues/1201)) * [`4267e28`](actions/setup-python@4267e28) Bump urllib3 from 1.26.19 to 2.5.0 in /**tests**/data and document breaking c... * See full diff in [compare view](actions/setup-python@e797f83...83679a8) [](https://docs.github.com/en/github/managing-security-vulnerabilities/about-dependabot-security-updates#about-compatibility-scores) Dependabot will resolve any conflicts with this PR as long as you don't alter it yourself. You can also trigger a rebase manually by commenting `@dependabot rebase`. [//]: # (dependabot-automerge-start) [//]: # (dependabot-automerge-end) --- Dependabot commands and options You can trigger Dependabot actions by commenting on this PR: - `@dependabot rebase` will rebase this PR - `@dependabot recreate` will recreate this PR, overwriting any edits that have been made to it - `@dependabot merge` will merge this PR after your CI passes on it - `@dependabot squash and merge` will squash and merge this PR after your CI passes on it - `@dependabot cancel merge` will cancel a previously requested merge and block automerging - `@dependabot reopen` will reopen this PR if it is closed - `@dependabot close` will close this PR and stop Dependabot recreating it. You can achieve the same result by closing it manually - `@dependabot show ignore conditions` will show all of the ignore conditions of the specified dependency - `@dependabot ignore this major version` will close this PR and stop Dependabot creating any more for this major version (unless you reopen the PR or upgrade to it yourself) - `@dependabot ignore this minor version` will close this PR and stop Dependabot creating any more for this minor version (unless you reopen the PR or upgrade to it yourself) - `@dependabot ignore this dependency` will close this PR and stop Dependabot creating any more for this dependency (unless you reopen the PR or upgrade to it yourself)
Description:
3.13 was added in a mass tune up in 0b93645 , without adjusting the wording. With 3.13 listed there too, example does not really make much sense. So I decided to make it explicit in wording and remove 3.13, so whenever next refactoring to add 3.14 to be added to every line where 3.13 is -- this would not even come to attention
Check list: