Merge pull request #24 from advanced-security/v0_1_2

feat(version): v0.1.2

Author: GeekMasher

.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

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/[email protected]
+INPUT_PACKS=advanced-security/[email protected]
+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:

Cargo.lock

@@ -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"

Cargo.toml

@@ -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/[email protected].1
+  uses: advanced-security/[email protected].2
   with:
     # Repository reference (e.g. "owner/repo", "owner/repo@ref")
     extractor: "advanced-security/codeql-extractor-iac"

README.md

@@ -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" ]