From 4f8c1004f571f4018f3dea84b5cda7f25f4e165a Mon Sep 17 00:00:00 2001 From: Daniel Testa Date: Thu, 12 Jun 2025 18:55:53 -0500 Subject: [PATCH 1/2] chore: test workflow --- .github/workflows/ci.yml | 9 +++++++++ 1 file changed, 9 insertions(+) create mode 100644 .github/workflows/ci.yml diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml new file mode 100644 index 0000000..75a1fae --- /dev/null +++ b/.github/workflows/ci.yml @@ -0,0 +1,9 @@ +name: Test Workflow +on: [push] +jobs: + test-workflow: + runs-on: ubuntu-latest + steps: + - uses: twincities-os/github-actions-examples@main + with: + MODEL_VERSION: 'v1.0' From b537b0a3a4c2c417dd3308bd14d5b9ba403d034e Mon Sep 17 00:00:00 2001 From: Daniel Testa Date: Thu, 12 Jun 2025 19:07:32 -0500 Subject: [PATCH 2/2] readme --- README.md | 32 +++++++++++++++++++++++++++++++- 1 file changed, 31 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index f78a363..9c5f082 100644 --- a/README.md +++ b/README.md @@ -1 +1,31 @@ -# GitHub Actions Examples \ No newline at end of file +# GitHub Actions Examples + +An example of building out a GitHub Action. + +## Usage + +Reference this action in your workflow: + +```yaml +- uses: twincities-os/github-actions-examples@main + with: + MODEL_VERSION: 'v1.0' +``` + +## Local Development + +### Prerequisites for Testing Locally + +- [Docker](https://docs.docker.com/get-docker/) +- [nektos/act](https://nektosact.com/installation/index.html) for local testing + +### Testing Locally + +```bash +# Run from repository root +act +``` + +### Testing in External Repository + +Test your changes by referencing the action from another repository, such as [test-github-actions](https://github.com/branberry/test-github-actions/blob/main/.github/workflows/ci.yml#L7-L9).