From 997a172ef517136a10f9435c200069bed9a883d1 Mon Sep 17 00:00:00 2001 From: Tycho Bokdam Date: Thu, 2 Mar 2023 11:49:44 +0100 Subject: [PATCH 1/2] docs: Updated README with how to test action --- .github/workflows/release.yml | 1 + .github/workflows/versioning.yml | 1 + README.md | 37 ++++++-------------------------- 3 files changed, 9 insertions(+), 30 deletions(-) diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml index ee039fb..24e93bd 100644 --- a/.github/workflows/release.yml +++ b/.github/workflows/release.yml @@ -7,6 +7,7 @@ on: jobs: release: runs-on: ubuntu-latest + if: ${{ !env.ACT }} steps: - name: Checkout code uses: actions/checkout@v2 diff --git a/.github/workflows/versioning.yml b/.github/workflows/versioning.yml index 5143980..e326498 100644 --- a/.github/workflows/versioning.yml +++ b/.github/workflows/versioning.yml @@ -7,6 +7,7 @@ on: jobs: run-tag-latest: runs-on: ubuntu-latest + if: ${{ !env.ACT }} steps: - uses: actions/checkout@v2 diff --git a/README.md b/README.md index 0daeb0c..860dd89 100644 --- a/README.md +++ b/README.md @@ -234,43 +234,20 @@ Use a deploy key If you'd like to contribute to this project, all you need to do is clone and install [act](https://github.com/nektos/act) this project and run: -> Make sure that `main: 'src/index.js'` is updated to `main: '../src/index.js'` inside the `action.yml` > Note: The image used is 18 gb! ```shell $ yarn install -# To run / test json versioning -$ act -j test-json -P ubuntu-latest=nektos/act-environments-ubuntu:18.04 -s github_token=fake-token +# To run / test one specific job +$ act -j -P ubuntu-latest=catthehacker/ubuntu:full-20.04 --quiet +# Example +$ act -j test-json -P ubuntu-latest=catthehacker/ubuntu:full-20.04 --quiet -# To run / test git versioning -$ act -j test-git -P ubuntu-latest=nektos/act-environments-ubuntu:18.04 -s github_token=fake-token - -# To run / test git fallback versioning -$ act -j test-git-fallback -P ubuntu-latest=nektos/act-environments-ubuntu:18.04 -s github_token=fake-token - -# To run / test yaml versioning -$ act -j test-yaml -P ubuntu-latest=nektos/act-environments-ubuntu:18.04 -s github_token=fake-token - -# To run / test toml versioning -$ act -j test-toml -P ubuntu-latest=nektos/act-environments-ubuntu:18.04 -s github_token=fake-token - -# To run / test empty / new files test -$ act -j test-[json/toml/yaml]-[empty/new] -P ubuntu-latest=nektos/act-environments-ubuntu:18.04 -s github_token=fake-token - -# To run pre-commit test -$ act -j test-pre-commit -P ubuntu-latest=nektos/act-environments-ubuntu:18.04 -s github_token=fake-token - -# To run / multiple files test -$ act -j multiple-files -P ubuntu-latest=nektos/act-environments-ubuntu:18.04 -s github_token=fake-token - -# To run / config file path test -$ act -j test-config-file-path -P ubuntu-latest=nektos/act-environments-ubuntu:18.04 -s github_token=fake-token - -# To run pre-changelog-generation test -$ act -j test-pre-changelog-generation -P ubuntu-latest=nektos/act-environments-ubuntu:18.04 -s github_token=fake-token +# To run all tests +$ act pull_request -P ubuntu-latest=catthehacker/ubuntu:full-20.04 --quiet ``` - +catthehacker/ubuntu:full-20.04 ## [License](./LICENSE) Conventional Changelog Action is [MIT licensed](./LICENSE). From 48193b9a39365a9d97b0a62fa58bd82653e7e07c Mon Sep 17 00:00:00 2001 From: Tycho Bokdam Date: Thu, 2 Mar 2023 11:50:21 +0100 Subject: [PATCH 2/2] refactor: Remove random text from README --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 860dd89..267e8ec 100644 --- a/README.md +++ b/README.md @@ -247,7 +247,7 @@ $ act -j test-json -P ubuntu-latest=catthehacker/ubuntu:full-20.04 --quiet # To run all tests $ act pull_request -P ubuntu-latest=catthehacker/ubuntu:full-20.04 --quiet ``` -catthehacker/ubuntu:full-20.04 + ## [License](./LICENSE) Conventional Changelog Action is [MIT licensed](./LICENSE).