Feature/722 nox session check#845
Conversation
464f88e to
cb2f05d
Compare
20dde53 to
806232b
Compare
|
|
||
| ## Summary | ||
|
|
||
| In this minor release, the nox session `workflow:check` was added and is now used in the `checks.yml`. |
There was a problem hiding this comment.
If a project is not ready for this, they can remove the job with the .workflow-patcher.yml.
By adding a comment at the top of workflows maintained by the PTB, we make it clearer what is maintained vs not by us. Additionally, by adding when it was last updated, it gives the projects using the PTB a direct idea of when this was last touched before checking the git blame. [The PTB currently lacks a mechanism to say when a workflow was removed or not, but this comment could give an important hint. It also encourages user to NOT modify the .yml files but let the PTB maintain them.]
| poetry run -- nox -s workflow:check --help | ||
|
|
||
| Use ``workflow:generate`` to create or update workflows and ``workflow:check`` to | ||
| compare the generated workflows against the files in ``.github/workflows``. |
There was a problem hiding this comment.
compare the generated workflows against the files in
.github/workflows
This I don't understand, I thought the generated workflows would be in .github/workflows
maybe: compare the workflows that would be generated against ...
There was a problem hiding this comment.
Ah, we compare the string content of the generated workflows to the existing files. Yeah, that could be better worded 😅 I updated the text so hopefully it's a bit clearer 😊
|



closes #722
closes #642
closes #698
closes #690 (last child task)
Checklist
Note: If any of the items in the checklist are not relevant to your PR, just check the box.
For any Pull Request
Is the following correct:
When Changes Were Made
Did you:
When Preparing a Release
Have you: