From fc51b8f902855f9f1cbc8b417fc65d8ed757cbbe Mon Sep 17 00:00:00 2001 From: Jim Segal Date: Mon, 21 Oct 2024 14:46:59 -0500 Subject: [PATCH] fix: sync elixir versions, add usage section (#40) --- README.md | 7 +++++++ templates/.github/workflows/common-config.yaml | 2 +- 2 files changed, 8 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 8a4a00b..bc420d4 100644 --- a/README.md +++ b/README.md @@ -13,3 +13,10 @@ Currently at version `1.5.0` - `scripts` contains javascript and elixir scripts that are ran on each repository. These could be as simple as copying a file to the repository, or as advanced as changing the `mix.exs` AST to update dependencies. - `templates` contains files that are copied or templated to the repository. + +## Usage + +- Copy [./templates/.github/workflows/common-config.yaml](./templates/.github/workflows/common-config.yaml) file into your repo's `/.github/workflows/` directory. +- Alter your common-config.yaml file by replacing `$\{{` with `${{`. +- Create a PR. +- On initial merge and on a [recurring schedule](./templates/.github/workflows/common-config.yaml#L15), updates will be synced with this repository. diff --git a/templates/.github/workflows/common-config.yaml b/templates/.github/workflows/common-config.yaml index 3fc9b15..a9062e0 100644 --- a/templates/.github/workflows/common-config.yaml +++ b/templates/.github/workflows/common-config.yaml @@ -38,7 +38,7 @@ jobs: uses: stordco/actions-elixir/setup@v1 with: github-token: $\{{ secrets.GH_PERSONAL_ACCESS_TOKEN }} - elixir-version: "1.15" + elixir-version: "1.16" otp-version: "26.0" - name: Sync