diff --git a/.github/linters/.checkov.yaml b/.github/linters/.checkov.yaml deleted file mode 100644 index c306051..0000000 --- a/.github/linters/.checkov.yaml +++ /dev/null @@ -1,6 +0,0 @@ -quiet: true -skip-check: - # Ensure that HEALTHCHECK instructions have been added to container images - - CKV_DOCKER_2 - # Ensure that a user for the container has been created - - CKV_DOCKER_3 diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index 424f06e..1b344dc 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -2,6 +2,8 @@ name: Continuous Integration on: pull_request: + branches: + - main push: branches: - main diff --git a/.github/workflows/linter.yml b/.github/workflows/linter.yml index be00c92..5608770 100644 --- a/.github/workflows/linter.yml +++ b/.github/workflows/linter.yml @@ -1,7 +1,14 @@ +# This workflow will lint the entire codebase using the +# `super-linter/super-linter` action. +# +# For more information, see the super-linter repository: +# https://github.com/super-linter/super-linter name: Lint Codebase on: pull_request: + branches: + - main push: branches: - main @@ -29,4 +36,5 @@ jobs: env: DEFAULT_BRANCH: main GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} + LINTER_RULES_PATH: ${{ github.workspace }} VALIDATE_ALL_CODEBASE: true diff --git a/.github/linters/.markdown-lint.yml b/.markdown-lint.yml similarity index 67% rename from .github/linters/.markdown-lint.yml rename to .markdown-lint.yml index cb5883f..0f9e8be 100644 --- a/.github/linters/.markdown-lint.yml +++ b/.markdown-lint.yml @@ -1,7 +1,13 @@ +# See: https://github.com/DavidAnson/markdownlint + # Unordered list style MD004: style: dash +# Disable line length for tables +MD013: + tables: false + # Ordered list item prefix MD029: style: one diff --git a/.prettierrc.json b/.prettierrc.json deleted file mode 100644 index a378146..0000000 --- a/.prettierrc.json +++ /dev/null @@ -1,16 +0,0 @@ -{ - "printWidth": 80, - "tabWidth": 2, - "useTabs": false, - "semi": false, - "singleQuote": true, - "quoteProps": "as-needed", - "jsxSingleQuote": false, - "trailingComma": "none", - "bracketSpacing": true, - "bracketSameLine": true, - "arrowParens": "avoid", - "proseWrap": "always", - "htmlWhitespaceSensitivity": "css", - "endOfLine": "lf" -} diff --git a/.prettierrc.yml b/.prettierrc.yml new file mode 100644 index 0000000..49c9385 --- /dev/null +++ b/.prettierrc.yml @@ -0,0 +1,16 @@ +# See: https://prettier.io/docs/en/configuration + +printWidth: 80 +tabWidth: 2 +useTabs: false +semi: false +singleQuote: true +quoteProps: as-needed +jsxSingleQuote: false +trailingComma: none +bracketSpacing: true +bracketSameLine: true +arrowParens: always +proseWrap: always +htmlWhitespaceSensitivity: css +endOfLine: lf diff --git a/.github/linters/.yaml-lint.yml b/.yaml-lint.yml similarity index 74% rename from .github/linters/.yaml-lint.yml rename to .yaml-lint.yml index c975a33..f382152 100644 --- a/.github/linters/.yaml-lint.yml +++ b/.yaml-lint.yml @@ -1,3 +1,5 @@ +# See: https://yamllint.readthedocs.io/en/stable/ + rules: document-end: disable document-start: @@ -8,3 +10,5 @@ rules: max: 80 allow-non-breakable-words: true allow-non-breakable-inline-mappings: true +ignore: + - .licenses/ diff --git a/CODEOWNERS b/CODEOWNERS index 2e08bd2..da17f53 100644 --- a/CODEOWNERS +++ b/CODEOWNERS @@ -1,3 +1,7 @@ -# Repository CODEOWNERS +############################################################################ +# Repository CODEOWNERS # +# Order is important! The last matching pattern takes the most precedence. # +############################################################################ +# Default owners, unless a later match takes precedence. * @actions/actions-oss-maintainers diff --git a/README.md b/README.md index 9d53b0c..9cc38f4 100644 --- a/README.md +++ b/README.md @@ -1,23 +1,16 @@ -# Container Action Template +# Create a Container Action [![GitHub Super-Linter](https://github.com/actions/container-action/actions/workflows/linter.yml/badge.svg)](https://github.com/super-linter/super-linter) +[![Check dist/](https://github.com/actions/container-action/actions/workflows/check-dist.yml/badge.svg)](https://github.com/actions/container-action/actions/workflows/check-dist.yml) ![CI](https://github.com/actions/container-action/actions/workflows/ci.yml/badge.svg) +[![CodeQL](https://github.com/actions/container-action/actions/workflows/codeql-analysis.yml/badge.svg)](https://github.com/actions/container-action/actions/workflows/codeql-analysis.yml) +[![Coverage](./badges/coverage.svg)](./badges/coverage.svg) Use this template to bootstrap the creation of a container action. :rocket: This template includes compilation support, tests, a validation workflow, publishing, and versioning guidance. -If you are new, there's also a simpler introduction in the -[Hello World Docker Action](https://github.com/actions/hello-world-docker-action) -repository. - -If you would like to use the -[GitHub Actions Toolkit](https://github.com/actions/toolkit) in your container -action, see the -[Container Toolkit Action](https://github.com/actions/container-toolkit-action) -repository. - ## Create Your Own Action To create your own action, you can use this repository as a template! Just @@ -166,7 +159,7 @@ So, what are you waiting for? Go ahead and start customizing your action! Your action is now published! :rocket: For information about versioning your action, see -[Versioning](https://github.com/actions/toolkit/blob/master/docs/action-versioning.md) +[Versioning](https://github.com/actions/toolkit/blob/main/docs/action-versioning.md) in the GitHub Actions toolkit. ## Validate the Action @@ -179,7 +172,7 @@ action in the same repository. steps: - name: Checkout id: checkout - uses: actions/checkout@v3 + uses: actions/checkout@v4 - name: Test Local Action id: test-action @@ -199,7 +192,7 @@ For example workflow runs, check out the After testing, you can create version tag(s) that developers can use to reference different stable versions of your action. For more information, see -[Versioning](https://github.com/actions/toolkit/blob/master/docs/action-versioning.md) +[Versioning](https://github.com/actions/toolkit/blob/main/docs/action-versioning.md) in the GitHub Actions toolkit. To include the action in a workflow in another repository, you can use the @@ -210,7 +203,7 @@ hash. steps: - name: Checkout id: checkout - uses: actions/checkout@v3 + uses: actions/checkout@v4 - name: Test Local Action id: test-action diff --git a/action.yml b/action.yml index 6a12f41..b124ffa 100644 --- a/action.yml +++ b/action.yml @@ -1,18 +1,23 @@ -name: 'The name of your action here' -description: 'Provide a description here' -author: 'Your name or organization here' +name: The name of your action here +description: Provide a description here +author: Your name or organization here + +# Add your action's branding here. This will appear on the GitHub Marketplace. +branding: + icon: heart + color: red # Define your inputs here. inputs: who-to-greet: - description: 'Your input description here' + description: Your input description here required: true - default: 'World' + default: World # Define your outputs here. outputs: greeting: - description: 'Your output description here' + description: Your output description here runs: using: docker