diff --git a/.release.yml b/.release.yml index 5174914..3e26315 100644 --- a/.release.yml +++ b/.release.yml @@ -1,6 +1,6 @@ name: "codeql-extractor-action" repository: "advanced-security/codeql-extractor-action" -version: 0.1.1 +version: 0.1.2 ecosystems: - Docs diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 4d64863..85ae470 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -36,9 +36,42 @@ If you have an idea for a new feature or enhancement, please open an issue on Gi - [Rust](https://www.rust-lang.org/tools/install) - [Cargo](https://doc.rust-lang.org/cargo/getting-started/installation.html) -- [CodeQL](https://codeql.github.com/docs/codeql-cli/getting-started/) +- [CodeQL](https://codeql.github.com/docs/codeql-cli/getting-started/) (optional as the action will download it for you) - `gh-codeql` is a great tool to help you with CodeQL CLI. +## Local Setup + +### Environment Variables + +To run the action locally, you need to set up the following environment variables: + +```env +# DEBUG=1 +GITHUB_REPOSITORY=advanced-security/codeql-extractor-action + +INPUT_EXTRACTORS=advanced-security/codeql-extractor-iac@v0.5.0 +INPUT_PACKS=advanced-security/iac-queries@0.5.0 +INPUT_LANGUAGES=iac +``` + +These are the inputs to the action. You can modify them as needed. + +### Building the Project + +To build the project, use the following command: + +```bash +cargo build --release +``` + +And to install it on the system, use: + +```bash +cargo install --path . +``` + +This means it can be run from anywhere using the command `codeql-extractor-action`. + ### Running Tests To run the tests, use the following command: diff --git a/Cargo.lock b/Cargo.lock index 32d3c9a..efe76a7 100644 --- a/Cargo.lock +++ b/Cargo.lock @@ -241,7 +241,7 @@ dependencies = [ [[package]] name = "codeql-extractor-action" -version = "0.1.1" +version = "0.1.2" dependencies = [ "anyhow", "dotenvy", diff --git a/Cargo.toml b/Cargo.toml index 696de10..ad9827e 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -1,7 +1,7 @@ [package] name = "codeql-extractor-action" description = "GitHub Action for CodeQL Extractors" -version = "0.1.1" +version = "0.1.2" authors = ["GeekMasher"] license = "MIT" diff --git a/README.md b/README.md index 1dcb45f..b8cb3f2 100644 --- a/README.md +++ b/README.md @@ -29,7 +29,7 @@ This action is designed to be used in conjunction with the [CodeQL][CodeQL] anal ```yml - name: "CodeQL Extractor Action" - uses: advanced-security/codeql-extractor-action@v0.1.1 + uses: advanced-security/codeql-extractor-action@v0.1.2 with: # Repository reference (e.g. "owner/repo", "owner/repo@ref") extractor: "advanced-security/codeql-extractor-iac" diff --git a/action.Dockerfile b/action.Dockerfile index 77a1da3..b95123f 100644 --- a/action.Dockerfile +++ b/action.Dockerfile @@ -1,3 +1,3 @@ -FROM ghcr.io/advanced-security/codeql-extractor-action:v0.1.0 +FROM ghcr.io/advanced-security/codeql-extractor-action:v0.1.2 ENTRYPOINT [ "codeql-extractor-action" ]