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

Jump to bottom

Github Actions YAML python-version example should use strings, not floats #11019

Open
1 task done
alexkyllo opened this issue Oct 10, 2021 · 5 comments · May be fixed by #11226 or #11539
Open
1 task done

Github Actions YAML python-version example should use strings, not floats #11019

alexkyllo opened this issue Oct 10, 2021 · 5 comments · May be fixed by #11226 or #11539
Labels
content good first issue help wanted
Projects
Docs team reviews

Comments

Assignees
No one assigned
Labels
content good first issue help wanted
Projects
Docs team reviews
Help wanted
Milestone
No milestone
Linked pull requests

Successfully merging a pull request may close this issue.

add quotes around python versions in gha examples
Specify Python version as strings
4 participants
@alexkyllo @skedwards88 @ramyaparimi and others
@alexkyllo
Copy link

@alexkyllo alexkyllo commented Oct 10, 2021 •
edited

Code of Conduct

What article on docs.github.com is affected?

Building and testing Python

What part(s) of the article would you like to see updated?

The python-version example should use strings and not floats.

jobs:
  build:

    runs-on: ubuntu-latest
    strategy:
      matrix:
        python-version: [3.6, 3.7, 3.8, 3.9]

should be

jobs:
  build:

    runs-on: ubuntu-latest
    strategy:
      matrix:
        python-version: ["3.6", "3.7", "3.8", "3.9"]

Why? Because Python 3.10 is out, and if it's specified as a float, it gets interpreted as 3.1. Using strings instead of floats in the docs will help many users avoid this pitfall.
@welcome
Copy link

@welcome welcome bot commented Oct 10, 2021

Thanks for opening this issue. A GitHub docs team member should be by to give feedback soon. In the meantime, please check out the contributing guidelines.

@ramyaparimi
Copy link
Collaborator

@ramyaparimi ramyaparimi commented Oct 11, 2021

@alexkyllo
Thanks so much for opening an issue! I'll triage this for the team to take a look 👀

@ramyaparimi ramyaparimi added this to Content review needed in Docs team reviews Oct 11, 2021
@ramyaparimi ramyaparimi moved this from Content review needed to Discuss in daily sync in Docs team reviews Oct 11, 2021
@ramyaparimi ramyaparimi moved this from Discuss in daily sync to Content review needed in Docs team reviews Oct 11, 2021
@skedwards88
Copy link
Contributor

@skedwards88 skedwards88 commented Oct 13, 2021

Thanks for opening this issue! You or anyone is welcome to open a PR to address this.

@docubot docubot moved this from Content review needed to Help wanted in Docs team reviews Oct 13, 2021
@skedwards88 skedwards88 mentioned this issue Oct 13, 2021
Open
@skedwards88
Copy link
Contributor

@skedwards88 skedwards88 commented Oct 13, 2021

I also opened a corresponding issue for the template workflows that this article is based off of: actions/starter-workflows#1158

@alexkyllo alexkyllo mentioned this issue Oct 16, 2021
Open
@alexkyllo alexkyllo linked a pull request that will close this issue Oct 16, 2021
Open
5 tasks
dbarbier added a commit to dbarbier/scikit-decide that referenced this issue Oct 19, 2021
@dbarbier
Version numbers are strings
3366704 
Without quotes, version number is considered as a float, which will
cause trouble with Python 3.10.

See github/docs#11019
@dbarbier dbarbier mentioned this issue Oct 19, 2021
Open
@thewheat thewheat linked a pull request that will close this issue Oct 30, 2021
Open
5 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment