From 7b61ff53317bbb026a391c7e720986f53fc5ec2a Mon Sep 17 00:00:00 2001 From: Federico Grandi Date: Sun, 23 Jan 2022 23:22:02 +0100 Subject: [PATCH] docs: fix outdated docs about the `pull` input closes #354 --- CHANGELOG.md | 1 + README.md | 6 +++--- 2 files changed, 4 insertions(+), 3 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index f1753a7e..991ce6ea 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -18,6 +18,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 - **[BREAKING]** The `signoff` input has been removed, use `commit` instead. (#331) - **[BREAKING]** The `pull_strategy` input has been removed, use `pull` instead. - **[BREAKING]** The `branch` and `branch_mode` inputs have been removed, check commit [`6fdb34e`](https://github.com/EndBug/add-and-commit/commit/6fdb34ed01d242c909eeb7e31bf1c4d37db43a54) for more info. +- **[BREAKING]** The `pull` input doesn't support `NO-PULL` anymore: if you don't want the action to pull, simply remove the input, as it's the default behavior now. ### Added: diff --git a/README.md b/README.md index e5f43a71..a46fde4b 100644 --- a/README.md +++ b/README.md @@ -66,9 +66,9 @@ Add a step like this to your workflow: # Default: ignore pathspec_error_handling: ignore - # Arguments for the git pull command. Use NO-PULL to avoid the action pulling at all. - # Default: '--no-rebase' - pull: 'NO-PULL or --rebase --autostash ...' + # Arguments for the git pull command. By default, the action does not pull. + # Default: '' + pull: '--rebase --autostash ...' # Whether to push the commit and, if any, its tags to the repo. It can also be used to set the git push arguments (see the paragraph below for more info) # Default: true