Update README with detailed information by aeisenberg · Pull Request #2415 · github/codeql-action

aeisenberg · 2024-08-07T21:20:44Z

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.

aeisenberg · 2024-08-07T21:22:32Z

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.

angelapwen · 2024-08-21T21:18:38Z

@aeisenberg just checking, is this PR ready for review by a human or not yet? 🤖

aeisenberg · 2024-08-21T21:59:31Z

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.

angelapwen · 2024-08-21T23:24:11Z

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. * **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).

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 · 2024-10-03T20:54:10Z

@angelapwen This is now ready for review. Can you take a look when you have a chance?

angelapwen

Just a few questions!! Thanks!

angelapwen · 2024-10-03T21:23:50Z

+
+Actions with special purposes and unlikely to be used directly:
+
+- `autobuild`: (Deprecated) Attempts to automatically build the code. Only used for analyzing languages that require a build. Use the `build-mode: autobuild` input in the `init` action instead. For information about input parameters, see the [autobuild action definition](https://github.com/github/codeql-action/blob/main/autobuild/action.yml).


Is autobuild officially deprecated? I might have missed that 🤔

It's not deprecated yet. I should probably remove the tag, but it's a good discussion to have.

Makes sense 👍 I think we should also remove it from the description in the .yml file too then!

angelapwen · 2024-10-03T21:24:35Z

+- `resolve-environment`: Attempts to infer a build environment suitable for automatic builds. For information about input parameters, see the [resolve-environment action definition](https://github.com/github/codeql-action/blob/main/resolve-environment/action.yml).
+- `start-proxy`: Starts an HTTP proxy server for downloading dependencies in private registries. For information about input parameters, see the [start-proxy action definition](https://github.com/github/codeql-action/blob/main/start-proxy/action.yml).


We might want to label these experimental (they're labeled that way in the definitions). Also, start-proxy is explicitly for internal GH use only — not sure if we want to advertise it in the README?

Good point.

I think it's worth keeping start-proxy since the action exists and users can see it, but I will make sure it's clear that it's internal use only.

aeisenberg · 2024-08-07T21:20:44Z

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.

aeisenberg · 2024-08-07T21:22:32Z

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.

angelapwen · 2024-08-21T21:18:38Z

@aeisenberg just checking, is this PR ready for review by a human or not yet? 🤖

aeisenberg · 2024-08-21T21:59:31Z

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.

angelapwen · 2024-08-21T23:24:11Z

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. * **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).

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 · 2024-10-03T20:54:10Z

@angelapwen This is now ready for review. Can you take a look when you have a chance?

angelapwen

Just a few questions!! Thanks!

angelapwen · 2024-10-03T21:23:50Z

+
+Actions with special purposes and unlikely to be used directly:
+
+- `autobuild`: (Deprecated) Attempts to automatically build the code. Only used for analyzing languages that require a build. Use the `build-mode: autobuild` input in the `init` action instead. For information about input parameters, see the [autobuild action definition](https://github.com/github/codeql-action/blob/main/autobuild/action.yml).


Is autobuild officially deprecated? I might have missed that 🤔

It's not deprecated yet. I should probably remove the tag, but it's a good discussion to have.

Makes sense 👍 I think we should also remove it from the description in the .yml file too then!

angelapwen · 2024-10-03T21:24:35Z

+- `resolve-environment`: Attempts to infer a build environment suitable for automatic builds. For information about input parameters, see the [resolve-environment action definition](https://github.com/github/codeql-action/blob/main/resolve-environment/action.yml).
+- `start-proxy`: Starts an HTTP proxy server for downloading dependencies in private registries. For information about input parameters, see the [start-proxy action definition](https://github.com/github/codeql-action/blob/main/start-proxy/action.yml).


We might want to label these experimental (they're labeled that way in the definitions). Also, start-proxy is explicitly for internal GH use only — not sure if we want to advertise it in the README?

Good point.

I think it's worth keeping start-proxy since the action exists and users can see it, but I will make sure it's clear that it's internal use only.

aeisenberg · 2024-08-07T21:20:44Z

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.

aeisenberg · 2024-08-07T21:22:32Z

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.

angelapwen · 2024-08-21T21:18:38Z

@aeisenberg just checking, is this PR ready for review by a human or not yet? 🤖

aeisenberg · 2024-08-21T21:59:31Z

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.

angelapwen · 2024-08-21T23:24:11Z

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. * **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).

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 · 2024-10-03T20:54:10Z

@angelapwen This is now ready for review. Can you take a look when you have a chance?

angelapwen

Just a few questions!! Thanks!

angelapwen · 2024-10-03T21:23:50Z

+
+Actions with special purposes and unlikely to be used directly:
+
+- `autobuild`: (Deprecated) Attempts to automatically build the code. Only used for analyzing languages that require a build. Use the `build-mode: autobuild` input in the `init` action instead. For information about input parameters, see the [autobuild action definition](https://github.com/github/codeql-action/blob/main/autobuild/action.yml).


Is autobuild officially deprecated? I might have missed that 🤔

It's not deprecated yet. I should probably remove the tag, but it's a good discussion to have.

Makes sense 👍 I think we should also remove it from the description in the .yml file too then!

angelapwen · 2024-10-03T21:24:35Z

+- `resolve-environment`: Attempts to infer a build environment suitable for automatic builds. For information about input parameters, see the [resolve-environment action definition](https://github.com/github/codeql-action/blob/main/resolve-environment/action.yml).
+- `start-proxy`: Starts an HTTP proxy server for downloading dependencies in private registries. For information about input parameters, see the [start-proxy action definition](https://github.com/github/codeql-action/blob/main/start-proxy/action.yml).


We might want to label these experimental (they're labeled that way in the definitions). Also, start-proxy is explicitly for internal GH use only — not sure if we want to advertise it in the README?

Good point.

I think it's worth keeping start-proxy since the action exists and users can see it, but I will make sure it's clear that it's internal use only.

aeisenberg · 2024-08-07T21:20:44Z

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.

aeisenberg · 2024-08-07T21:22:32Z

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.

angelapwen · 2024-08-21T21:18:38Z

@aeisenberg just checking, is this PR ready for review by a human or not yet? 🤖

aeisenberg · 2024-08-21T21:59:31Z

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.

angelapwen · 2024-08-21T23:24:11Z

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. * **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).

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 · 2024-10-03T20:54:10Z

@angelapwen This is now ready for review. Can you take a look when you have a chance?

angelapwen

Just a few questions!! Thanks!

angelapwen · 2024-10-03T21:23:50Z

+
+Actions with special purposes and unlikely to be used directly:
+
+- `autobuild`: (Deprecated) Attempts to automatically build the code. Only used for analyzing languages that require a build. Use the `build-mode: autobuild` input in the `init` action instead. For information about input parameters, see the [autobuild action definition](https://github.com/github/codeql-action/blob/main/autobuild/action.yml).


Is autobuild officially deprecated? I might have missed that 🤔

It's not deprecated yet. I should probably remove the tag, but it's a good discussion to have.

Makes sense 👍 I think we should also remove it from the description in the .yml file too then!

angelapwen · 2024-10-03T21:24:35Z

+- `resolve-environment`: Attempts to infer a build environment suitable for automatic builds. For information about input parameters, see the [resolve-environment action definition](https://github.com/github/codeql-action/blob/main/resolve-environment/action.yml).
+- `start-proxy`: Starts an HTTP proxy server for downloading dependencies in private registries. For information about input parameters, see the [start-proxy action definition](https://github.com/github/codeql-action/blob/main/start-proxy/action.yml).


We might want to label these experimental (they're labeled that way in the definitions). Also, start-proxy is explicitly for internal GH use only — not sure if we want to advertise it in the README?

Good point.

I think it's worth keeping start-proxy since the action exists and users can see it, but I will make sure it's clear that it's internal use only.

aeisenberg · 2024-08-07T21:20:44Z

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.

aeisenberg · 2024-08-07T21:22:32Z

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.

angelapwen · 2024-08-21T21:18:38Z

@aeisenberg just checking, is this PR ready for review by a human or not yet? 🤖

aeisenberg · 2024-08-21T21:59:31Z

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.

angelapwen · 2024-08-21T23:24:11Z

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. * **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).

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 · 2024-10-03T20:54:10Z

@angelapwen This is now ready for review. Can you take a look when you have a chance?

angelapwen

Just a few questions!! Thanks!

angelapwen · 2024-10-03T21:23:50Z

+
+Actions with special purposes and unlikely to be used directly:
+
+- `autobuild`: (Deprecated) Attempts to automatically build the code. Only used for analyzing languages that require a build. Use the `build-mode: autobuild` input in the `init` action instead. For information about input parameters, see the [autobuild action definition](https://github.com/github/codeql-action/blob/main/autobuild/action.yml).


Is autobuild officially deprecated? I might have missed that 🤔

It's not deprecated yet. I should probably remove the tag, but it's a good discussion to have.

Makes sense 👍 I think we should also remove it from the description in the .yml file too then!

angelapwen · 2024-10-03T21:24:35Z

+- `resolve-environment`: Attempts to infer a build environment suitable for automatic builds. For information about input parameters, see the [resolve-environment action definition](https://github.com/github/codeql-action/blob/main/resolve-environment/action.yml).
+- `start-proxy`: Starts an HTTP proxy server for downloading dependencies in private registries. For information about input parameters, see the [start-proxy action definition](https://github.com/github/codeql-action/blob/main/start-proxy/action.yml).


We might want to label these experimental (they're labeled that way in the definitions). Also, start-proxy is explicitly for internal GH use only — not sure if we want to advertise it in the README?

Good point.

I think it's worth keeping start-proxy since the action exists and users can see it, but I will make sure it's clear that it's internal use only.

aeisenberg · 2024-08-07T21:20:44Z

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.

aeisenberg · 2024-08-07T21:22:32Z

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.

angelapwen · 2024-08-21T21:18:38Z

@aeisenberg just checking, is this PR ready for review by a human or not yet? 🤖

aeisenberg · 2024-08-21T21:59:31Z

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.

angelapwen · 2024-08-21T23:24:11Z

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. * **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).

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 · 2024-10-03T20:54:10Z

@angelapwen This is now ready for review. Can you take a look when you have a chance?

angelapwen

Just a few questions!! Thanks!

angelapwen · 2024-10-03T21:23:50Z

+
+Actions with special purposes and unlikely to be used directly:
+
+- `autobuild`: (Deprecated) Attempts to automatically build the code. Only used for analyzing languages that require a build. Use the `build-mode: autobuild` input in the `init` action instead. For information about input parameters, see the [autobuild action definition](https://github.com/github/codeql-action/blob/main/autobuild/action.yml).


Is autobuild officially deprecated? I might have missed that 🤔

It's not deprecated yet. I should probably remove the tag, but it's a good discussion to have.

Makes sense 👍 I think we should also remove it from the description in the .yml file too then!

angelapwen · 2024-10-03T21:24:35Z

+- `resolve-environment`: Attempts to infer a build environment suitable for automatic builds. For information about input parameters, see the [resolve-environment action definition](https://github.com/github/codeql-action/blob/main/resolve-environment/action.yml).
+- `start-proxy`: Starts an HTTP proxy server for downloading dependencies in private registries. For information about input parameters, see the [start-proxy action definition](https://github.com/github/codeql-action/blob/main/start-proxy/action.yml).


We might want to label these experimental (they're labeled that way in the definitions). Also, start-proxy is explicitly for internal GH use only — not sure if we want to advertise it in the README?

Good point.

I think it's worth keeping start-proxy since the action exists and users can see it, but I will make sure it's clear that it's internal use only.

aeisenberg · 2024-08-07T21:20:44Z

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.

aeisenberg · 2024-08-07T21:22:32Z

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.

angelapwen · 2024-08-21T21:18:38Z

@aeisenberg just checking, is this PR ready for review by a human or not yet? 🤖

aeisenberg · 2024-08-21T21:59:31Z

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.

angelapwen · 2024-08-21T23:24:11Z

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. * **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).

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 · 2024-10-03T20:54:10Z

@angelapwen This is now ready for review. Can you take a look when you have a chance?

angelapwen

Just a few questions!! Thanks!

angelapwen · 2024-10-03T21:23:50Z

+
+Actions with special purposes and unlikely to be used directly:
+
+- `autobuild`: (Deprecated) Attempts to automatically build the code. Only used for analyzing languages that require a build. Use the `build-mode: autobuild` input in the `init` action instead. For information about input parameters, see the [autobuild action definition](https://github.com/github/codeql-action/blob/main/autobuild/action.yml).


Is autobuild officially deprecated? I might have missed that 🤔

It's not deprecated yet. I should probably remove the tag, but it's a good discussion to have.

Makes sense 👍 I think we should also remove it from the description in the .yml file too then!

angelapwen · 2024-10-03T21:24:35Z

+- `resolve-environment`: Attempts to infer a build environment suitable for automatic builds. For information about input parameters, see the [resolve-environment action definition](https://github.com/github/codeql-action/blob/main/resolve-environment/action.yml).
+- `start-proxy`: Starts an HTTP proxy server for downloading dependencies in private registries. For information about input parameters, see the [start-proxy action definition](https://github.com/github/codeql-action/blob/main/start-proxy/action.yml).


We might want to label these experimental (they're labeled that way in the definitions). Also, start-proxy is explicitly for internal GH use only — not sure if we want to advertise it in the README?

Good point.

I think it's worth keeping start-proxy since the action exists and users can see it, but I will make sure it's clear that it's internal use only.

aeisenberg · 2024-08-07T21:20:44Z

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.

aeisenberg · 2024-08-07T21:22:32Z

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.

angelapwen · 2024-08-21T21:18:38Z

@aeisenberg just checking, is this PR ready for review by a human or not yet? 🤖

aeisenberg · 2024-08-21T21:59:31Z

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.

angelapwen · 2024-08-21T23:24:11Z

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. * **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).

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 · 2024-10-03T20:54:10Z

@angelapwen This is now ready for review. Can you take a look when you have a chance?

angelapwen

Just a few questions!! Thanks!

angelapwen · 2024-10-03T21:23:50Z

+
+Actions with special purposes and unlikely to be used directly:
+
+- `autobuild`: (Deprecated) Attempts to automatically build the code. Only used for analyzing languages that require a build. Use the `build-mode: autobuild` input in the `init` action instead. For information about input parameters, see the [autobuild action definition](https://github.com/github/codeql-action/blob/main/autobuild/action.yml).


Is autobuild officially deprecated? I might have missed that 🤔

It's not deprecated yet. I should probably remove the tag, but it's a good discussion to have.

Makes sense 👍 I think we should also remove it from the description in the .yml file too then!

angelapwen · 2024-10-03T21:24:35Z

+- `resolve-environment`: Attempts to infer a build environment suitable for automatic builds. For information about input parameters, see the [resolve-environment action definition](https://github.com/github/codeql-action/blob/main/resolve-environment/action.yml).
+- `start-proxy`: Starts an HTTP proxy server for downloading dependencies in private registries. For information about input parameters, see the [start-proxy action definition](https://github.com/github/codeql-action/blob/main/start-proxy/action.yml).


We might want to label these experimental (they're labeled that way in the definitions). Also, start-proxy is explicitly for internal GH use only — not sure if we want to advertise it in the README?

Good point.

I think it's worth keeping start-proxy since the action exists and users can see it, but I will make sure it's clear that it's internal use only.

aeisenberg requested a review from a team as a code owner August 7, 2024 21:20

aeisenberg marked this pull request as draft August 7, 2024 21:21

aeisenberg changed the title ~~Update README with detailed information~~[WIP] Update README with detailed informationAug 7, 2024

aeisenberg changed the title ~~[WIP] Update README with detailed information~~Update README with detailed information Aug 9, 2024

aeisenberg marked this pull request as ready for review August 9, 2024 20:30

aeisenberg force-pushed the aeisenberg/update-readme-1 branch from 885261b to 0f63feeCompare August 9, 2024 20:48

github deleted a comment Aug 19, 2024

aeisenberg added 2 commits October 3, 2024 13:42

Clean up README
c768f67
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 0f63fee to c768f67Compare October 3, 2024 20:52

angelapwen reviewed Oct 3, 2024
View reviewed changes

aeisenberg added 2 commits October 3, 2024 15:06

Update readme
3b143d4

Update autobuild/action.yml
bed2a47

angelapwen approved these changes Oct 4, 2024
View reviewed changes

aeisenberg merged commit 46d955c into github:mainOct 4, 2024

This was referenced Oct 7, 2024
Merge main into releases/v3 #2529
Merged
Merge releases/v3 into releases/v2 #2531
Merged