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

Improve Advanced Usage examples #645

Merged
merged 4 commits into from
Jan 27, 2025
Merged

Conversation

lrq3000
Copy link
Contributor

@lrq3000 lrq3000 commented Apr 9, 2023

Description:
A few improvement of Advanced Usage examples:

  • Rework outputs python-version to replace missing words in description and clarify example.
  • Mention '*' for python-version to get the latest stable python release.
  • Mention that if statements need to use single-quotes, not double-quotes (and not no-quotes) to test python-version against string literals.

I tried to keep with the conventions used elsewhere in the document, and for my contributions to be as concise as possible (eg, the if statement is not its own paragraph but is just one additional line in the Matrix Testing example, the most relevant one as it's the most common case scenario for an if testing).

Related issue:
Closes #644.

Check list:

  • Mark if documentation changes are required.
  • Mark if tests were added or updated to cover the changes.

@lrq3000 lrq3000 requested a review from a team as a code owner April 9, 2023 20:33
@mahabaleshwars mahabaleshwars self-assigned this Nov 13, 2024
@mahabaleshwars mahabaleshwars added the documentation Improvements or additions to documentation label Nov 13, 2024
@mahabaleshwars
Copy link

Hello @lrq3000,
Thank you for submitting this PR! Could you please update the documentation to reflect the changes to the supported Python versions? Specifically, you need to remove Python 2.7, 3.7, 3.8 and PyPy 2.7 from the documentation, as they are no longer supported by the Python Software Foundation and the broader Python ecosystem.
Additionally, as mentioned earlier, please remove the '*' symbol from the documentation, as it is not recommended.
Furthermore, please update the workflow example as follows:

jobs:
  build:
    runs-on: ${{ matrix.os }}
    strategy:
      fail-fast: false
      matrix:
        os: [ubuntu-latest, macos-latest, windows-latest]
        python-version: [ '3.9', '3.10', '3.11', 'pypy3.8']
    steps:
      - uses: actions/checkout@v4
      - name: Set up Python
        uses: actions/setup-python@v5
        with:
          python-version: ${{ matrix.python-version }}
      - name: Display Python version
        if: ${{ matrix.python-version != 'pypy3.8' }}  # Use single quotes in expressions for input `python-version`
        run: python --version

This update includes:

  1. Removing Python 2.7 and PyPy 2.7 from the matrix since they are no longer supported.
  2. Changing the Python versions in the matrix to reflect supported versions (3.9, 3.10, 3.11, pypy3.8).
  3. Adding an if condition to ensure that the python --version command is not executed for pypy3.8, to account for the fact that pypy handles Python versions differently.

Let me know if you have any questions!

@mahabaleshwars
Copy link

Hi lrq3000,

I hope you're doing well! I wanted to check in and see if you've had a chance to go through the feedback comment I left. Please let me know if you need any clarification or further details.

Thanks!

lrq3000 and others added 4 commits December 29, 2024 12:32
Description was lacking words, example was misleading (id was set to cp310 which clearly was a reference to CPython 3.10, but the id is referring to the setup-python action!
Signed-off-by: Stephen L. <lrq3000@gmail.com>
Signed-off-by: Stephen L. <lrq3000@gmail.com>
….7, 3.7, 3.8, tweak example, remove wildcard *)

Signed-off-by: Stephen L. <LRQ3000@gmail.com>
@lrq3000
Copy link
Contributor Author

lrq3000 commented Dec 29, 2024

@mahabaleshwars Thank you for pinging me, my apologies, I did not see your previous messages. I now have updated my PR according to your suggestions and I have rebased on the latest upstream commit, so you won't have to mergediff.

Note that I slightly modified the example you suggested, as I think it is useful to keep the example excludes, to show how this can be done.

Please feel free to modify the PR further as you see fit.

BTW happy end-of-year celebrations!

@HarithaVattikuti HarithaVattikuti merged commit 4237552 into actions:main Jan 27, 2025
3 checks passed
mergify bot added a commit to ArcadeData/arcadedb that referenced this pull request Feb 3, 2025
Bumps [actions/setup-python](https://github.com/actions/setup-python) from 5.3.0 to 5.4.0.
Release notes

*Sourced from [actions/setup-python's releases](https://github.com/actions/setup-python/releases).*

> v5.4.0
> ------
> 
> What's Changed
> --------------
> 
> ### Enhancements:
> 
> * Update cache error message by [`@​aparnajyothi-y`](https://github.com/aparnajyothi-y) in [actions/setup-python#968](https://redirect.github.com/actions/setup-python/pull/968)
> * Enhance Workflows: Add Ubuntu-24, Remove Python 3.8 by [`@​priya-kinthali`](https://github.com/priya-kinthali) in [actions/setup-python#985](https://redirect.github.com/actions/setup-python/pull/985)
> * Configure Dependabot settings by [`@​HarithaVattikuti`](https://github.com/HarithaVattikuti) in [actions/setup-python#1008](https://redirect.github.com/actions/setup-python/pull/1008)
> 
> ### Documentation changes:
> 
> * Readme update - recommended permissions by [`@​benwells`](https://github.com/benwells) in [actions/setup-python#1009](https://redirect.github.com/actions/setup-python/pull/1009)
> * Improve Advanced Usage examples by [`@​lrq3000`](https://github.com/lrq3000) in [actions/setup-python#645](https://redirect.github.com/actions/setup-python/pull/645)
> 
> ### Dependency updates:
> 
> * Upgrade `undici` from 5.28.4 to 5.28.5 by [`@​dependabot`](https://github.com/dependabot) in [actions/setup-python#1012](https://redirect.github.com/actions/setup-python/pull/1012)
> * Upgrade `urllib3` from 1.25.9 to 1.26.19 in /**tests**/data by [`@​dependabot`](https://github.com/dependabot) in [actions/setup-python#895](https://redirect.github.com/actions/setup-python/pull/895)
> * Upgrade `actions/publish-immutable-action` from 0.0.3 to 0.0.4 by [`@​dependabot`](https://github.com/dependabot) in [actions/setup-python#1014](https://redirect.github.com/actions/setup-python/pull/1014)
> * Upgrade `@actions/http-client` from 2.2.1 to 2.2.3 by [`@​dependabot`](https://github.com/dependabot) in [actions/setup-python#1020](https://redirect.github.com/actions/setup-python/pull/1020)
> * Upgrade `requests` from 2.24.0 to 2.32.2 in /**tests**/data by [`@​dependabot`](https://github.com/dependabot) in [actions/setup-python#1019](https://redirect.github.com/actions/setup-python/pull/1019)
> * Upgrade `@actions/cache` to `^4.0.0` by [`@​priyagupta108`](https://github.com/priyagupta108) in [actions/setup-python#1007](https://redirect.github.com/actions/setup-python/pull/1007)
> 
> New Contributors
> ----------------
> 
> * [`@​benwells`](https://github.com/benwells) made their first contribution in [actions/setup-python#1009](https://redirect.github.com/actions/setup-python/pull/1009)
> * [`@​HarithaVattikuti`](https://github.com/HarithaVattikuti) made their first contribution in [actions/setup-python#1008](https://redirect.github.com/actions/setup-python/pull/1008)
> * [`@​lrq3000`](https://github.com/lrq3000) made their first contribution in [actions/setup-python#645](https://redirect.github.com/actions/setup-python/pull/645)
> 
> **Full Changelog**: <actions/setup-python@v5...v5.4.0>


Commits

* [`4237552`](actions/setup-python@4237552) Improve Advanced Usage examples ([#645](https://redirect.github.com/actions/setup-python/issues/645))
* [`709bfa5`](actions/setup-python@709bfa5) Bump requests from 2.24.0 to 2.32.2 in /**tests**/data ([#1019](https://redirect.github.com/actions/setup-python/issues/1019))
* [`ceb20b2`](actions/setup-python@ceb20b2) Bump `@​actions/http-client` from 2.2.1 to 2.2.3 ([#1020](https://redirect.github.com/actions/setup-python/issues/1020))
* [`0dc2d2c`](actions/setup-python@0dc2d2c) Bump actions/publish-immutable-action from 0.0.3 to 0.0.4 ([#1014](https://redirect.github.com/actions/setup-python/issues/1014))
* [`feb9c6e`](actions/setup-python@feb9c6e) Bump urllib3 from 1.25.9 to 1.26.19 in /**tests**/data ([#895](https://redirect.github.com/actions/setup-python/issues/895))
* [`d0b4fc4`](actions/setup-python@d0b4fc4) Bump undici from 5.28.4 to 5.28.5 ([#1012](https://redirect.github.com/actions/setup-python/issues/1012))
* [`e3dfaac`](actions/setup-python@e3dfaac) Configure Dependabot settings ([#1008](https://redirect.github.com/actions/setup-python/issues/1008))
* [`b8cf3eb`](actions/setup-python@b8cf3eb) Use the new cache service: upgrade `@actions/cache` to `^4.0.0` ([#1007](https://redirect.github.com/actions/setup-python/issues/1007))
* [`1928ae6`](actions/setup-python@1928ae6) Update README.md ([#1009](https://redirect.github.com/actions/setup-python/issues/1009))
* [`3fddbee`](actions/setup-python@3fddbee) Enhance Workflows: Add Ubuntu-24, Remove Python 3.8 ([#985](https://redirect.github.com/actions/setup-python/issues/985))
* Additional commits viewable in [compare view](actions/setup-python@0b93645...4237552)

  

[![Dependabot compatibility score](https://dependabot-badges.githubapp.com/badges/compatibility\_score?dependency-name=actions/setup-python&package-manager=github\_actions&previous-version=5.3.0&new-version=5.4.0)](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)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Cannot test matrix.python-version in a if statement if version is dynamic (eg, *, 3.12-dev, 3.x)
4 participants