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

State what python version is used in README #187

Merged
merged 4 commits into from
Feb 14, 2024

Conversation

shenxianpeng
Copy link
Collaborator

@shenxianpeng shenxianpeng commented Feb 4, 2024

Based on your description in #185, I've created this PR for you to review to close #185

We now have an additional place in the README that needs to be updated manually when Python version is upgraded

@shenxianpeng shenxianpeng added the documentation Improvements or additions to documentation label Feb 4, 2024
@shenxianpeng shenxianpeng requested a review from 2bndy5 February 4, 2024 04:52
@shenxianpeng shenxianpeng marked this pull request as ready for review February 4, 2024 04:52
@2bndy5
Copy link
Collaborator

2bndy5 commented Feb 4, 2024

We now have an additional place in the README that needs to be updated manually when Python version is upgraded

We could use the permalink https://github.com/cpp-linter/cpp-linter-action/blob/bb0610e1deae636c111f86d8839c04b916ba67ef/action.yml#L120 which github would render as:

python-version: '3.10'

But we would still have to update the permalink if future changes to action.yml changes the line number.

README.md Outdated Show resolved Hide resolved
Co-authored-by: Brendan <[email protected]>
@shenxianpeng
Copy link
Collaborator Author

shenxianpeng commented Feb 4, 2024

The permalink explains why python 3.10 is better, perhaps less appropriate put it for the README. users can find out why with #185.
And the explanation you added “Our intention is to synchronize with the default python version included with Ubuntu latest LTS releases.” should be enough.

@2bndy5
Copy link
Collaborator

2bndy5 commented Feb 4, 2024

I'm going to push some changes...

  • docker images not maintained by GitHub

    This seems like it is not a precise description (that's my mistake). I think "third-party docker images" might be better. Or maybe a direct link to the github docs about specifying a "job's container image" (which is different from the job's runner image).

  • The placement of the note breaks the flow of paragraphs. I'm moving it up a bit.

@2bndy5
Copy link
Collaborator

2bndy5 commented Feb 4, 2024

Please hold off from merging this

The info provided isn't completely accurate to the current latest cpp-linter-action release (which uses py v3.11).

@2bndy5
Copy link
Collaborator

2bndy5 commented Feb 4, 2024

We should merge this only when we're ready to make a new release. We also have to satisfy #182 (with another round of testing).

@shenxianpeng
Copy link
Collaborator Author

shenxianpeng commented Feb 4, 2024

The info provided isn't completely accurate to the current latest cpp-linter-action release (which uses py v3.11).

users who used cpp-linter-action@v2 already used python 3.10 when #186 was merged.

I made a mistake. Unless we create a new version, python 3.10 will apply to the new version tag and v2.

@2bndy5 2bndy5 merged commit ca16ecb into main Feb 14, 2024
32 checks passed
@2bndy5 2bndy5 deleted the shenxianpeng/state-what-python-185 branch February 14, 2024 03:10
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.

State what python version is used in README
2 participants