From e400f5dc9da85cc3cabe8bbed3cf445f4b9d606a Mon Sep 17 00:00:00 2001 From: RDW Date: Mon, 29 May 2023 11:28:26 +0200 Subject: [PATCH 1/2] Docs: Add some usage instructions to the README --- README.md | 15 +++++++++++++++ 1 file changed, 15 insertions(+) diff --git a/README.md b/README.md index 81a66aa..6f4416d 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,17 @@ # evo-setup-action + GitHub Action to set up the Evo.lua runtime (for CI runs) + +## Usage + +You can find an example here: [test.yml](.github/workflows/test.yml). Here's what you need to know: + +* Set the `version` input to the desired runtime version (must be a [tagged release](https://github.com/evo-lua/evo-runtime/releases)) +* You can use `main` or a [tagged release](https://github.com/evo-lua/evo-setup-action/releases) for this action itself by setting `@` +* On Linux, the action will take longer to run as it has to install dependencies first + +The above workflow is automatically tested, so you can always use it as a reference. + +## Status + +Very experimental and expected to evolve over time (just like the `evo` runtime itself). \ No newline at end of file From 72b75ebc2e2a6840224566d69b1b7f6044bfac8d Mon Sep 17 00:00:00 2001 From: RDW Date: Mon, 29 May 2023 11:43:27 +0200 Subject: [PATCH 2/2] CI: Add an exclusion rule for MD files to the test workflow No need to test the action if it hasn't actually changed. --- .github/workflows/test.yml | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml index 43b2f7d..9eb0935 100644 --- a/.github/workflows/test.yml +++ b/.github/workflows/test.yml @@ -3,8 +3,13 @@ name: Test evo-setup-action on: push: branches: [ main ] + paths-ignore: + - '**.md' pull_request: + types: [opened, synchronize, reopened, ready_for_review] branches: [ main ] + paths-ignore: + - '**.md' jobs: gha-test: