diff --git a/README.md b/README.md index 925f6e127..4493efb1e 100644 --- a/README.md +++ b/README.md @@ -14,7 +14,7 @@ Use Macaron as a GitHub Action To use the Macaron GitHub Action, add the following step to your workflow (adjust the version as needed). In this example, we use an example policy. For detailed instructions and a comprehensive list of available options, please refer to the [Macaron GitHub Action documentation](https://oracle.github.io/macaron/pages/macaron_action.html). ```yaml -- uses: oracle/macaron@v0.21.0 +- uses: oracle/macaron@v0.22.0 with: repo_path: 'https://github.com/example/project' policy_file: check-github-actions diff --git a/action.yaml b/action.yaml index f28f9d2e9..418f37705 100644 --- a/action.yaml +++ b/action.yaml @@ -1,9 +1,12 @@ -# Copyright (c) 2025 - 2025, Oracle and/or its affiliates. All rights reserved. +# Copyright (c) 2025 - 2026, Oracle and/or its affiliates. All rights reserved. # Licensed under the Universal Permissive License v 1.0 as shown at https://oss.oracle.com/licenses/upl/. -name: Macaron Security Analysis -description: Run Macaron to analyze supply chain security +name: Macaron Security Analysis Action +description: Run Macaron to analyze artifacts for supply chain security author: Oracle - github.com/oracle/macaron +branding: + icon: shield + color: blue # This composite GitHub Action wraps the Macaron tool. It exposes inputs for analysis options to shell scripts under `scripts/actions/` for readability. inputs: diff --git a/docs/source/pages/macaron_action.rst b/docs/source/pages/macaron_action.rst index 6c7db9407..dc8ebb477 100644 --- a/docs/source/pages/macaron_action.rst +++ b/docs/source/pages/macaron_action.rst @@ -18,8 +18,8 @@ When using this action you can reference the action in your workflow. Example: runs-on: ubuntu-latest steps: - uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0 - - name: Run Macaron Security Analysis - uses: oracle/macaron@v0.21.0 + - name: Run Macaron Security Analysis Action + uses: oracle/macaron@v0.22.0 with: repo_path: 'https://github.com/example/project' policy_file: check-github-actions @@ -37,7 +37,7 @@ directory containing ``macaron.db``: .. code-block:: yaml - name: Verify policy - uses: oracle/macaron@v0.21.0 + uses: oracle/macaron@v0.22.0 with: policy_file: policy.dl output_dir: macaron-output