From 3c7e5742722ef217c61b9bc9be0a68b4b8615bb8 Mon Sep 17 00:00:00 2001 From: Peter Evans <18365890+peter-evans@users.noreply.github.com> Date: Mon, 3 Apr 2023 11:34:27 +0900 Subject: [PATCH] docs: update notes --- docs/updating.md | 13 +++++++------ 1 file changed, 7 insertions(+), 6 deletions(-) diff --git a/docs/updating.md b/docs/updating.md index f798dc5..820321a 100644 --- a/docs/updating.md +++ b/docs/updating.md @@ -1,6 +1,6 @@ ## Updating from `v4` to `v5` -### Breaking changes +### Behaviour changes - The action will no longer leave the local repository checked out on the pull request `branch`. Instead, it will leave the repository checked out on the branch or commit that it was when the action started. - When using `add-paths`, uncommitted changes will no longer be destroyed. They will be stashed and restored at the end of the action run. @@ -10,12 +10,13 @@ - At the end of the action run the local repository is now checked out on the branch or commit that it was when the action started. - Any uncommitted tracked or untracked changes are now stashed and restored at the end of the action run. Currently, this can only occur when using the `add-paths` input, which allows for changes to not be committed. Previously, any uncommitted changes would be destroyed. - The proxy implementation has been revised but is not expected to have any change in behaviour. It continues to support the standard environment variables `http_proxy`, `https_proxy` and `no_proxy`. -- The action now sets the git `safe.directory` configuration for the local repository path. The configuration is removed when the action completes. Fixes issue https://github.com/peter-evans/create-pull-request/issues/1170. -- The action now determines the git directory path using the `git rev-parse --git-dir` command. This allows users with custom repository configurations to use the action. +- Now sets the git `safe.directory` configuration for the local repository path. The configuration is removed when the action completes. Fixes issue https://github.com/peter-evans/create-pull-request/issues/1170. +- Now determines the git directory path using the `git rev-parse --git-dir` command. This allows users with custom repository configurations to use the action. +- Improved handling of the `team-reviewers` input and associated errors. ## Updating from `v3` to `v4` -### Breaking changes +### Behaviour changes - The `add-paths` input no longer accepts `-A` as a valid value. When committing all new and modified files the `add-paths` input should be omitted. @@ -29,7 +30,7 @@ ## Updating from `v2` to `v3` -### Breaking changes +### Behaviour changes - The `author` input now defaults to the user who triggered the workflow run. This default is set via [action.yml](../action.yml) as `${{ github.actor }} <${{ github.actor }}@users.noreply.github.com>`, where `github.actor` is the GitHub user account associated with the run. For example, `peter-evans `. @@ -77,7 +78,7 @@ ## Updating from `v1` to `v2` -### Breaking changes +### Behaviour changes - `v2` now expects repositories to be checked out with `actions/checkout@v2`