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

Update README with detailed information #2415

Merged
merged 4 commits into from
Oct 4, 2024

Commits on Oct 3, 2024

  1. Update README with detailed information

    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 committed Oct 3, 2024
    Configuration menu
    Copy the full SHA
    873c91c View commit details
    Browse the repository at this point in the history
  2. Clean up README

    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 committed Oct 3, 2024
    Configuration menu
    Copy the full SHA
    c768f67 View commit details
    Browse the repository at this point in the history
  3. Update readme

    aeisenberg committed Oct 3, 2024
    Configuration menu
    Copy the full SHA
    3b143d4 View commit details
    Browse the repository at this point in the history

Commits on Oct 4, 2024

  1. Configuration menu
    Copy the full SHA
    bed2a47 View commit details
    Browse the repository at this point in the history