actions/container-toolkit-action
1
0
Fork 0
mirror of https://github.com/actions/container-toolkit-action.git synced 2025-12-13 13:42:13 +00:00
Code Issues Packages Projects Releases Wiki Activity

fix: update README badges and improve setup instructions

Browse Source
This commit is contained in:
Nick Alteen
2025-07-11 13:29:14 -04:00
parent 853aefde6b
commit 30d149dcc2
1 changed files with 18 additions and 16 deletions
Download Patch File Download Diff File Expand all files Collapse all files

34
README.md
View File

@@ -1,9 +1,10 @@
# Create a Container Action with the GitHub Actions Toolkit # Create a Container Action with the GitHub Actions Toolkit
[![GitHub Super-Linter](https://github.com/actions/container-toolkit-action/actions/workflows/linter.yml/badge.svg)](https://github.com/super-linter/super-linter) [![GitHub Super-Linter](https://github.com/actions/container-toolkit-action/actions/workflows/linter.yml/badge.svg)](https://github.com/super-linter/super-linter)
![Check `dist/`](https://github.com/actions/container-toolkit-action/actions/workflows/check-dist.yml/badge.svg) [![Check dist/](https://github.com/actions/container-toolkit-action/actions/workflows/check-dist.yml/badge.svg)](https://github.com/actions/container-toolkit-action/actions/workflows/check-dist.yml)
![CI](https://github.com/actions/container-toolkit-action/actions/workflows/ci.yml/badge.svg) ![CI](https://github.com/actions/container-toolkit-action/actions/workflows/ci.yml/badge.svg)
[![Code Coverage](./badges/coverage.svg)](./badges/coverage.svg) [![CodeQL](https://github.com/actions/container-toolkit-action/actions/workflows/codeql-analysis.yml/badge.svg)](https://github.com/actions/container-toolkit-action/actions/workflows/codeql-analysis.yml)
[![Coverage](./badges/coverage.svg)](./badges/coverage.svg)
Use this template to bootstrap the creation of a container action with the Use this template to bootstrap the creation of a container action with the
GitHub Actions toolkit. :rocket: GitHub Actions toolkit. :rocket:
@@ -38,10 +39,16 @@ need to perform some initial setup steps before you can develop your action.
> [!NOTE] > [!NOTE]
> >
> You'll need to have reasonably modern versions of > You'll need to have a reasonably modern version of
> [Node.js](https://nodejs.org) and > [Node.js](https://nodejs.org) and
> [Docker](https://www.docker.com/get-started/) handy (e.g. Node.js v20+ and > [Docker](https://www.docker.com/get-started/) handy (Node.js v20.x or later
> docker engine v20+). > and Docker engine v20+ or later should work!). If you are using a version
> manager like [`nodenv`](https://github.com/nodenv/nodenv) or
> [`fnm`](https://github.com/Schniz/fnm), this template has a `.node-version`
> file at the root of the repository that can be used to automatically switch to
> the correct version when you `cd` into the repository. Additionally, this
> `.node-version` file is used by GitHub Actions in any `actions/setup-node`
> actions.
1. :hammer_and_wrench: Install the dependencies 1. :hammer_and_wrench: Install the dependencies
@@ -194,14 +201,10 @@ So, what are you waiting for? Go ahead and start customizing your action!
npm run all npm run all
``` ```
> [!WARNING] > This step is important! It will run [`rollup`](https://rollupjs.org/) to
> > build the final JavaScript action code with all dependencies included. If
> This step is important! It will run [`ncc`](https://github.com/vercel/ncc) > you do not run this step, your action will not work correctly when it is
> to build the final JavaScript action code with all dependencies included. > used in a workflow.
> If you do not run this step, your action will not work correctly when it is
> used in a workflow. This step also includes the `--license` option for
> `ncc`, which will create a license file for all of the production node
> modules used in your project.
1. Commit your changes 1. Commit your changes
@@ -222,7 +225,7 @@ So, what are you waiting for? Go ahead and start customizing your action!
Your action is now published! :rocket: Your action is now published! :rocket:
For information about versioning your action, see 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. in the GitHub Actions toolkit.
## Validate the Action ## Validate the Action
@@ -249,8 +252,7 @@ steps:
``` ```
For example workflow runs, check out the For example workflow runs, check out the
[Actions tab](https://github.com/actions/container-toolkit-action/actions)! [Actions tab](https://github.com/actions/typescript-action/actions)! :rocket:
:rocket:
## Usage ## Usage