From 855954fd33ac20d215d6535d3f58f377da4cdf67 Mon Sep 17 00:00:00 2001 From: "commit-action-helper-bot[bot]" <206927528+commit-action-helper-bot[bot]@users.noreply.github.com> Date: Tue, 22 Apr 2025 16:04:39 +0000 Subject: [PATCH] chore(readme): update readme for v0.4.2 [BOT] --- README.md | 14 +++++++++----- 1 file changed, 9 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index c9892da8..db771c40 100644 --- a/README.md +++ b/README.md @@ -4,11 +4,11 @@ # GitHub Api Commit -This action commits to the checked out repo via the graphql mutation `createCommitOnBranch`. This mutation supports +This action commits to the checked-out repo via the graphql mutation `createCommitOnBranch`. This mutation supports signing commits automatically for the user. This is useful when using a GitHub App to do committing for bot-related -commits and the repo requires signed commits. + commits, and the repo requires signed commits. -It will build a list of file additions and deletions to commit, and just prior to committing will fetch the latest +It will build a list of file additions and deletions to commit, and just before committing will fetch the latest commit OID from the remote repo. It will commit to whatever branch is currently checked out in the workflow. For instance, if you create a branch via `git checkout -b my-test-branch` in one of your steps, it will commit to `my-test-branch`. @@ -17,7 +17,7 @@ instance, if you create a branch via `git checkout -b my-test-branch` in one of ```yaml - name: Commit changes - uses: grafana/github-api-commit-action@217dd3b6fd87795791baec73516d331c3839bc42 # v0.4.1 + uses: grafana/github-api-commit-action@4eceeb68aa8b00d6acdf43eef81e2ceea9b432fb # v0.4.2 with: commit-message: "" # Commit message defaults to "Commit performed by grafana/github-api-commit-action" create-branch-on-remote: true | false # Whether to create the branch on the remote if it doesn't exist: Defaults to false @@ -36,7 +36,7 @@ instance, if you create a branch via `git checkout -b my-test-branch` in one of private_key: ${{ secrets.GITHUB_APP_PRIVATE_KEY }} - name: Commit changes - uses: grafana/github-api-commit-action@217dd3b6fd87795791baec73516d331c3839bc42 # v0.4.1 + uses: grafana/github-api-commit-action@4eceeb68aa8b00d6acdf43eef81e2ceea9b432fb # v0.4.2 with: commit-message: "" # Commit message defaults to "Commit performed by grafana/github-api-commit-action" create-branch-on-remote: true | false # Whether to create the branch on the remote if it doesn't exist already: Defaults to false @@ -75,6 +75,10 @@ Example: `feat: add new commit signing feature` Since we use the `squash-merge` strategy, PR titles are required to be in Conventional Commits format to ensure that the merge commit message is defaulted correctly. +## Contributing + +See [CONTRIBUTING.md](CONTRIBUTING.md) for more information. + # (Legacy) GitHub Api Commit > [!NOTE]