-
Notifications
You must be signed in to change notification settings - Fork 315
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
Update README with detailed information #2415
base: main
Are you sure you want to change the base?
Conversation
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).
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. |
Restructured the change to the README. Instead of directly including the descriptions of the language inputs, added links to the inputs for each action.
885261b
to
0f63fee
Compare
@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 😸 |
Update
README.md
to include detailed information about inputs, workflow permissions, build modes, and actions.config
option,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.