Repository navigation
Respect proxy settings when streaming the download and extraction of the CodeQL bundle #2624
docs: add readme for justfile/pr-checks update
- Loading branch information
commit a89fbc80a21d76b6e2304d8ccf53ae01036b94ab
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,23 @@ | ||
| # PR Checks | ||
|
|
||
| This folder contains the code supporting the workflows run when a PR is created. | ||
|
|
||
| ## Update | ||
|
|
||
| If you need to make a change to any of the PR checks, you need to perform the following | ||
| steps: | ||
|
|
||
| 1. Make the change - the code for the PR checks is under the `pr-checks/checks/` folder. | ||
| 2. Run the `sync.py` file to produce (and sync) the final workflow files under `.github/` | ||
|
|
||
| The second part requires some associated steps (create a virtual environment, download | ||
| the dependencies for the Python script, etc), so we have automated this with the `justfile` | ||
| included in this folder. | ||
|
|
||
| ### 1-step update | ||
|
|
||
| 1. Install https://github.com/casey/just by whichever way you prefer. | ||
| 2. Run `$ just update-pr-checks` in your terminal. | ||
|
|
||
| If you don't wish to install `just`, you can also manually perform the steps | ||
| outlined in the `justfile` under the `update-pr-checks` action. | ||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think we can simplify this. I can give some suggestions, but not quite right now.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
See here for an alternative readme: https://github.com/github/codeql-action/compare/NlightNFotis/detect_use_proxy_when_streaming...aeisenberg/justfile-readme?quick_pull=1#diff-b90d48e45a6813fad7195d74075f05bdf05919291a02116fe8a6b67691b1266a
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thank you for this! I agree it looks cleaner.
Will
cherry-pickthis in.