Update README with detailed information #2415
Open
+39
−1
Conversation
This file contains 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
Update `README.md` to include detailed information about inputs, workflow permissions, build modes, and actions. * **Inputs**: Add a section on inputs, including the `config` option, `languages`, `queries`, `packs`, `db-location`, `ram`, `threads`, and `source-root`. * **Workflow Permissions**: Add a section on workflow permissions required for the actions. * **Build Modes**: Add a section explaining the different build modes available for the actions (`none`, `autobuild`, `manual`). * **Actions**: Add a section describing the different actions (`init`, `autobuild`, `analyze`, `upload-sarif`, `resolve-environment`, `start-proxy`) and how to use them, with links to the relevant documentation on GitHub. --- For more details, open the [Copilot Workspace session](https://copilot-workspace.githubnext.com/github/codeql-action?shareId=XXXX-XXXX-XXXX-XXXX).
aeisenberg
changed the title
|
Please ignore for now. I created this PR using a copilot workspace. There are a lot of things I need to clean up. I just wanted to try out using it. |
aeisenberg
changed the title
Restructured the change to the README. Instead of directly including the descriptions of the language inputs, added links to the inputs for each action.
aeisenberg
force-pushed
the
aeisenberg/update-readme-1
branch
from
885261b
to
0f63fee
Compare
FreeMason9224
approved these changes
Aug 16, 2024
|
@aeisenberg just checking, is this PR ready for review by a human or not yet? 🤖 |
|
It needs some more work. I haven't had a chance to really look at it. I'm not sure when I'll get another chance, so if you want to pick it up, feel free to. |
|
Ah, was just wondering if you were blocked on review 😸 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Update
README.mdto include detailed information about inputs, workflow permissions, build modes, and actions.configoption,languages,queries,packs,db-location,ram,threads, andsource-root.none,autobuild,manual).init,autobuild,analyze,upload-sarif,resolve-environment,start-proxy) and how to use them, with links to the relevant documentation on GitHub.For more details, open the Copilot Workspace session.