From 6bd6a93620b036f434e646dd763976e286be415f Mon Sep 17 00:00:00 2001 From: Josh Soref <2119212+jsoref@users.noreply.github.com> Date: Sun, 30 Mar 2025 15:09:31 -0400 Subject: [PATCH 01/11] spelling: automatically Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com> --- src/usage/index.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/usage/index.md b/src/usage/index.md index 0ee0c6b..279097e 100644 --- a/src/usage/index.md +++ b/src/usage/index.md @@ -139,7 +139,7 @@ If your workflow depends on this token, you need to create a [personal access to act -s GITHUB_TOKEN=[insert token or leave blank and omit equals for secure input] ``` -If [GitHub CLI](https://cli.github.com/) is installed, the [`gh auth token`](https://cli.github.com/manual/gh_auth_token) command can be used to autmatically pass the token to act +If [GitHub CLI](https://cli.github.com/) is installed, the [`gh auth token`](https://cli.github.com/manual/gh_auth_token) command can be used to automatically pass the token to act ```bash act -s GITHUB_TOKEN="$(gh auth token)" From 3bcb83b5520733978cc7baca8a5a00a5ddd04964 Mon Sep 17 00:00:00 2001 From: Josh Soref <2119212+jsoref@users.noreply.github.com> Date: Sun, 30 Mar 2025 15:13:05 -0400 Subject: [PATCH 02/11] spelling: every time Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com> --- src/usage/runners.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/usage/runners.md b/src/usage/runners.md index ae69ccb..6d25d57 100644 --- a/src/usage/runners.md +++ b/src/usage/runners.md @@ -62,7 +62,7 @@ act -P ubuntu-18.04=nektos/act-environments-ubuntu:18.04 -P ubuntu-latest=ubuntu ### Using local runner images -The `--pull` flag is set to true by default due to a breaking on older default docker images. This would pull the docker image everytime act is executed. +The `--pull` flag is set to true by default due to a breaking on older default docker images. This would pull the docker image every time act is executed. Set `--pull` to false if a local docker image is needed ```sh From 13655b0afff2b37a12f654232a1d1e263f31693f Mon Sep 17 00:00:00 2001 From: Josh Soref <2119212+jsoref@users.noreply.github.com> Date: Sun, 30 Mar 2025 15:08:38 -0400 Subject: [PATCH 03/11] spelling: its Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com> --- src/not_supported.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/not_supported.md b/src/not_supported.md index 8534220..acea5a1 100644 --- a/src/not_supported.md +++ b/src/not_supported.md @@ -9,7 +9,7 @@ Here is a list of features that is (yet) to be implemented or is decided as not - `concurrency` is ignored - `run-name` is ignored - Step summary not processed - - Values written in each step to the file pointed by `GITHUB_STEP_SUMMARY`, `$GITHUB_STEP_SUMMARY` and `$env:GITHUB_STEP_SUMMARY` are discarded, each step has it's own empty step summary file at the beginning + - Values written in each step to the file pointed by `GITHUB_STEP_SUMMARY`, `$GITHUB_STEP_SUMMARY` and `$env:GITHUB_STEP_SUMMARY` are discarded, each step has its own empty step summary file at the beginning - Problem matcher ignored - Annotations ignored - Incomplete `github` context From e51e0013f0e2716c758f052b2e493b37a0a8eafe Mon Sep 17 00:00:00 2001 From: Josh Soref <2119212+jsoref@users.noreply.github.com> Date: Sun, 30 Mar 2025 15:08:45 -0400 Subject: [PATCH 04/11] spelling: nonexistent Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com> --- src/usage/index.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/usage/index.md b/src/usage/index.md index 279097e..7b11507 100644 --- a/src/usage/index.md +++ b/src/usage/index.md @@ -303,7 +303,7 @@ If you want to speed up running act and using cached actions and container image - stops pulling existing images - stops failing if an action has been cached and you cannot connect to GitHub -- pulls non existent actions and images +- pulls nonexistent actions and images - act will work offline if it has at least ran once while you are online - get rid of unnecessary timeouts when you have an unstable connection to GitHub or Container registries - workaround rate limit problems From bd8238c0cf584fa07bae3aeeddfe35dfdd4fa653 Mon Sep 17 00:00:00 2001 From: Josh Soref <2119212+jsoref@users.noreply.github.com> Date: Sun, 30 Mar 2025 15:09:46 -0400 Subject: [PATCH 05/11] spelling: precedence Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com> --- src/usage/index.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/usage/index.md b/src/usage/index.md index 7b11507..72cc618 100644 --- a/src/usage/index.md +++ b/src/usage/index.md @@ -295,7 +295,7 @@ Similarly if we just wanted to trigger this workflow for node 10 and macos-lates This will trigger the workflow to use the following matrix configurations only: - `os: macos-latest, node 10` -Note that using the `--matrix` flag you can't add new values (for e.g. running the above workflow for node 20). It will simply ignore it. Moreover, the `exclude` field in the workflow will take precedance over the `--matrix` flag (for e.g. running the above workflow for only macos-latest and node 4 will result in no matrix configuration being used) +Note that using the `--matrix` flag you can't add new values (for e.g. running the above workflow for node 20). It will simply ignore it. Moreover, the `exclude` field in the workflow will take precedence over the `--matrix` flag (for e.g. running the above workflow for only macos-latest and node 4 will result in no matrix configuration being used) ## Action Offline Mode From 43374dbf304e3a41382bbb902bd588af16d5a9f6 Mon Sep 17 00:00:00 2001 From: Josh Soref <2119212+jsoref@users.noreply.github.com> Date: Sun, 30 Mar 2025 15:13:35 -0400 Subject: [PATCH 06/11] spelling: some-value Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com> --- src/usage/index.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/src/usage/index.md b/src/usage/index.md index 72cc618..9771e1a 100644 --- a/src/usage/index.md +++ b/src/usage/index.md @@ -110,7 +110,7 @@ Example: To run `act` with repository variables that are accessible inside the workflow via `${{ vars.VARIABLE }}`, you can enter them interactively or load them from a file. The following options are available for providing github repository variables: -- `act --var VARIABLE=somevalue` - use `somevalue` as the value for `VARIABLE`. +- `act --var VARIABLE=some-value` - use `some-value` as the value for `VARIABLE`. - `act --var-file my.variables` - load variables values from `my.variables` file. - The variables file format is the same as `.env` format @@ -126,7 +126,7 @@ When inserting sensitive data in your terminal, it might be saved as plain text --- -- `act -s MY_SECRET=somevalue` - use `somevalue` as the value for `MY_SECRET`. +- `act -s MY_SECRET=some-value` - use `some-value` as the value for `MY_SECRET`. - `act -s MY_SECRET` - check for an environment variable named `MY_SECRET` and use it if it exists. If the environment variable is not defined, prompt the user for a value. **This is recommended way of typing/pasting a secret into terminal, as `act` will provide secure input prompt for you to type/paste your secret which will not be saved in your shell history file.** - `act --secret-file my.secrets` - load secrets values from `my.secrets` file. - secrets file format is the same as `.env` format @@ -231,7 +231,7 @@ jobs: ### via input or input-file flag -- `act --input NAME=somevalue` - use `somevalue` as the value for `NAME` input. +- `act --input NAME=some-value` - use `some-value` as the value for `NAME` input. - `act --input-file my.input` - load input values from `my.input` file. - input file format is the same as `.env` format From af3f3498c7d2630f65d4ff4e830fd3c74db8930a Mon Sep 17 00:00:00 2001 From: Josh Soref <2119212+jsoref@users.noreply.github.com> Date: Sun, 30 Mar 2025 15:09:52 -0400 Subject: [PATCH 07/11] spelling: specific Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com> --- src/usage/runners.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/usage/runners.md b/src/usage/runners.md index 6d25d57..b31dcc7 100644 --- a/src/usage/runners.md +++ b/src/usage/runners.md @@ -13,7 +13,7 @@ In order for `act` to run your workflows locally, it must run a container for th [micro]: https://hub.docker.com/_/buildpack-deps [docker_images]: https://github.com/catthehacker/docker_images -If you want to run Windows and macOS based platforms and you are running act within that specfic environment you can opt out of docker and run them directly on your host system. +If you want to run Windows and macOS based platforms and you are running act within that specific environment you can opt out of docker and run them directly on your host system. Here are some examples ```sh From cbd89201697000f715726d6077272248c150cb57 Mon Sep 17 00:00:00 2001 From: Josh Soref <2119212+jsoref@users.noreply.github.com> Date: Sun, 30 Mar 2025 15:09:06 -0400 Subject: [PATCH 08/11] spelling: they Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com> --- src/usage/index.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/usage/index.md b/src/usage/index.md index 9771e1a..69dfaae 100644 --- a/src/usage/index.md +++ b/src/usage/index.md @@ -327,7 +327,7 @@ or a `.actrc` file in your cwd like to enable this feature use the cli flag `--artifact-server-path $PWD/.artifacts`. -While enabled these values are also available in `run` steps, which doesn't match `actions/runner` aka GitHub Actions where their are blank. +While enabled these values are also available in `run` steps, which doesn't match `actions/runner` aka GitHub Actions where they are blank. Currently `actions/upload-artifact@v3` and `actions/upload-artifact@v4` together with `actions/download-artifact@v3` and `actions/download-artifact@v4` should be able to upload and download their artifacts within the current workflow run. From 3c6c97122917292ee9d2e1b1e47d933405cf2ff7 Mon Sep 17 00:00:00 2001 From: Josh Soref <2119212+jsoref@users.noreply.github.com> Date: Sun, 30 Mar 2025 15:09:57 -0400 Subject: [PATCH 09/11] spelling: triggered Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com> --- src/usage/index.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/usage/index.md b/src/usage/index.md index 69dfaae..33fe45e 100644 --- a/src/usage/index.md +++ b/src/usage/index.md @@ -85,7 +85,7 @@ act -W '.github/workflows/checks.yml' ## Jobs -> By default `act` will run **all jobs** in **all workflows** that are triggerred by `push` event +> By default `act` will run **all jobs** in **all workflows** that are triggered by `push` event ```shell=sh act -j 'test' From f2cf66a3e2f39352f85277a40c202aedb90b07a2 Mon Sep 17 00:00:00 2001 From: Josh Soref <2119212+jsoref@users.noreply.github.com> Date: Sun, 30 Mar 2025 15:07:31 -0400 Subject: [PATCH 10/11] spelling: winget Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com> --- src/SUMMARY.md | 2 +- src/installation/index.md | 2 +- src/installation/winget.md | 4 ++-- 3 files changed, 4 insertions(+), 4 deletions(-) diff --git a/src/SUMMARY.md b/src/SUMMARY.md index bf2da0a..1f174a8 100644 --- a/src/SUMMARY.md +++ b/src/SUMMARY.md @@ -10,7 +10,7 @@ - [MacPorts](./installation/macports.md) - [Nix](./installation/nix.md) - [Scoop](./installation/scoop.md) - - [Winget](./installation/winget.md) + - [WinGet](./installation/winget.md) - [Usage guide](./usage/index.md) - [Runners](./usage/runners.md) - [Custom container engine](./usage/custom_engine.md) diff --git a/src/installation/index.md b/src/installation/index.md index e801d54..cb87c0e 100644 --- a/src/installation/index.md +++ b/src/installation/index.md @@ -67,7 +67,7 @@ go build -ldflags "-X main.version=$(git describe --tags --dirty --always | sed - [Nix/NixOS](./nix.md) (`Linux`, `macOS`) - [MacPorts](./macports.md) (`macOS`) - [Scoop](./scoop.md) (`Windows`) -- [Winget](./winget.md) (`Windows`) +- [WinGet](./winget.md) (`Windows`) ### Packaging status diff --git a/src/installation/winget.md b/src/installation/winget.md index a2adcc3..6404288 100644 --- a/src/installation/winget.md +++ b/src/installation/winget.md @@ -1,6 +1,6 @@ -# [Winget](https://learn.microsoft.com/en-us/windows/package-manager/) (Windows) +# [WinGet](https://learn.microsoft.com/en-us/windows/package-manager/) (Windows) -[![Winget package](https://repology.org/badge/version-for-repo/winget/act-run-github-actions.svg)](https://repology.org/project/act-run-github-actions/versions) +[![WinGet package](https://repology.org/badge/version-for-repo/winget/act-run-github-actions.svg)](https://repology.org/project/act-run-github-actions/versions) ```shell winget install nektos.act From fb2304b56beb5457100f3d2677891e1fa0bf9b23 Mon Sep 17 00:00:00 2001 From: Josh Soref <2119212+jsoref@users.noreply.github.com> Date: Mon, 31 Mar 2025 09:31:22 -0400 Subject: [PATCH 11/11] spelling: work around Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com> --- src/usage/index.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/usage/index.md b/src/usage/index.md index 33fe45e..92ba93a 100644 --- a/src/usage/index.md +++ b/src/usage/index.md @@ -306,7 +306,7 @@ If you want to speed up running act and using cached actions and container image - pulls nonexistent actions and images - act will work offline if it has at least ran once while you are online - get rid of unnecessary timeouts when you have an unstable connection to GitHub or Container registries -- workaround rate limit problems +- work around rate limit problems ```sh act --action-offline-mode