From afb4a798069a1bba148fd5ddbb9888a00190f2a8 Mon Sep 17 00:00:00 2001 From: Oliver Switzer Date: Mon, 2 Dec 2024 15:25:05 -0500 Subject: [PATCH] chore: Update CONTRIBUTING docs * Tweak github ci sed command to update version in README.md --- .github/workflows/publish.yml | 2 +- CONTRIBUTING.md | 5 +++++ 2 files changed, 6 insertions(+), 1 deletion(-) diff --git a/.github/workflows/publish.yml b/.github/workflows/publish.yml index 98215f0..8d4b781 100644 --- a/.github/workflows/publish.yml +++ b/.github/workflows/publish.yml @@ -57,7 +57,7 @@ jobs: # Update version in mix.exs sed -i 's/version: ".*"/version: "'${RELEASE_VERSION#v}'"/g' mix.exs - sed -i 's/\{:shortcut_api_ex, "*"/\{:shortcut_api_ex, "'${RELEASE_VERSION#v}'"/g' README.md + sed -i 's/\{:shortcut_api_ex, ".*"\}/\{:shortcut_api_ex, "'"${RELEASE_VERSION#v}"'"\}/g' README.md git add mix.exs git commit -m "chore: Bump version to ${RELEASE_VERSION}" git push origin $BRANCH_NAME diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 2c52bff..30a2ac0 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,3 +1,8 @@ +# Contributing + +## Use of aider for assistance + +We use aider to help facilitate making new modules here. It uses conventional commits, which our auto semantic versioning in CI pairs with nicely. ## Publishing a new commit