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

Use GH action version when version argument not specified #3543

Merged
merged 4 commits into from
Mar 28, 2023
Merged

Use GH action version when version argument not specified #3543

merged 4 commits into from
Mar 28, 2023

Conversation

Jackenmen
Copy link
Contributor

@Jackenmen Jackenmen commented Feb 2, 2023

Description

Resolves #3382

There are 2 things going on here:

  • addition of .git_archival.txt set with export-subst git attribute so that black can be installed from a git archive, see: https://github.com/pypa/setuptools_scm#git-archives
  • update to GH action changing it to use GH action version when the version argument is not specified; this means:
    • when the action's commit is tagged, install Black from PyPI using that tag's name as the pinned version
    • when the action's commit is not tagged, install Black from the action's local directory

A couple of tests:

Checklist - did you ...

  • Add an entry in CHANGES.md if necessary?
  • Add / update tests if necessary?
  • Add new / update outdated documentation?

@ichard26 ichard26 self-requested a review February 5, 2023 03:29
@ichard26 ichard26 added the C: integrations Editor plugins and other integrations label Feb 5, 2023
@Jackenmen Jackenmen marked this pull request as ready for review February 12, 2023 12:22
@Jackenmen
Copy link
Contributor Author

I added the changelog entry. I'm marking this as ready for review though I'd like to point out that I have not updated integration documentation yet because I'm not sure what parts of it you would want me to update if any. Arguably, the version input is still preferable since it allows matching stability policy with a specifier such as ~= 22.0 The main benefit of this change is avoiding confusion when someone specifies only the action version. But perhaps you would want me to change that whole document such that it recommends using the action version for pinning and version input for version ranges. Such a case could require significant document restructuring, so I'm holding off on that for now.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
C: integrations Editor plugins and other integrations
Projects
None yet
Development

Successfully merging this pull request may close these issues.

GitHub Action: Use action version as default Black version, instead of latest
3 participants