From 95615643f077d9869230c2e3716b90220490e543 Mon Sep 17 00:00:00 2001 From: Peter Evans Date: Sun, 29 Dec 2019 17:33:07 +0900 Subject: [PATCH] Add updating doc --- updating.md | 25 +++++++++++++++++++++++++ 1 file changed, 25 insertions(+) create mode 100644 updating.md diff --git a/updating.md b/updating.md new file mode 100644 index 0000000..09e8696 --- /dev/null +++ b/updating.md @@ -0,0 +1,25 @@ +# Updating from `v1` to `v2` + +## Breaking changes + +- `v2` now expects repositories to be checked out with `actions/checkout@v2` + + To use `actions/checkout@v1` the following step to checkout the branch is necessary. + ``` + - uses: actions/checkout@v1 + - name: Checkout branch + run: git checkout "${GITHUB_REF:11}" + ``` + +- The two branch naming strategies have been swapped. Fixed branch naming strategy is now the default. i.e. `branch-suffix: none` is now the default and should be removed from configuration if set. + +- `author-name`, `author-email`, `committer-name`, `committer-email` have been removed in favour of `author` and `committer`. + They can both be set in the format `Display Name ` + + If neither `author` or `committer` are set the action will default to making commits as the GitHub Actions bot user. + +## New features + +- Unpushed commits made during the workflow before the action runs will now be considered as changes to be raised in the pull request +- New commits made to the pull request base will now be taken into account when pull requests are updated +- If an updated pull request no longer differs from its base it will automatically be closed and the pull request branch deleted