diff --git a/CHANGELOG.md b/CHANGELOG.md index 787f5473..38c14274 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -4,11 +4,19 @@ All notable changes to this project will be documented in this file. The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/) and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html). -## [Unreleased](https://github.com/stefanzweifel/git-auto-commit-action/compare/v4.2.0...HEAD) +## [Unreleased](https://github.com/stefanzweifel/git-auto-commit-action/compare/v4.3.0...HEAD) > TBD +## [v4.3.0](https://github.com/stefanzweifel/git-auto-commit-action/compare/v4.2.0...v4.3.0) - 2020-05-16 + +Note: Since v4.3.0 we provide major version tags. You can now use `stefanzweifel/git-auto-commit-action@v4` to always use the latest release of a major version. See [#77](https://github.com/stefanzweifel/git-auto-commit-action/issues/77) for details. + +### Added +- Add new `push_options`-input. This feature makes it easier for you to force-push commits to a repository. [#78](https://github.com/stefanzweifel/git-auto-commit-action/pull/78), [#72](https://github.com/stefanzweifel/git-auto-commit-action/issues/72) + + ## [v4.2.0](https://github.com/stefanzweifel/git-auto-commit-action/compare/v4.1.6...v4.2.0) - 2020-05-10 ### Changed diff --git a/README.md b/README.md index 1a16197d..76af1f0c 100644 --- a/README.md +++ b/README.md @@ -13,7 +13,7 @@ This Action has been inspired and adapted from the [auto-commit](https://github. Add the following step at the end of your job, after other steps that might add or change files. ```yaml -- uses: stefanzweifel/git-auto-commit-action@v4.2.0 +- uses: stefanzweifel/git-auto-commit-action@v4 with: # Required commit_message: Apply automatic changes @@ -71,7 +71,7 @@ jobs: - name: Run php-cs-fixer uses: docker://oskarstark/php-cs-fixer-ga - - uses: stefanzweifel/git-auto-commit-action@v4.2.0 + - uses: stefanzweifel/git-auto-commit-action@v4 with: commit_message: Apply php-cs-fixer changes ``` @@ -142,7 +142,7 @@ If your repository uses [protected branches](https://help.github.com/en/github/a You have to enable force pushes to a protected branch (See [documentation](https://help.github.com/en/github/administering-a-repository/enabling-force-pushes-to-a-protected-branch)) and update your Workflow to use force push like so. ```yaml - - uses: stefanzweifel/git-auto-commit-action@v4.2.0 + - uses: stefanzweifel/git-auto-commit-action@v4 with: commit_message: Apply php-cs-fixer changes push_options: --force @@ -156,6 +156,9 @@ This is due to limitations set up by GitHub, [commits of this Action do not trig We use [SemVer](http://semver.org/) for versioning. For the versions available, see the [tags on this repository](https://github.com/stefanzweifel/git-auto-commit-action/tags). +We also provide major version tags to make it easier to always use the latest release of a major version. For example you can use `stefanzweifel/git-auto-commit-action@v4` to always use the latest release of the current major version. +(More information about this [here](https://github.com/actions/toolkit/blob/master/docs/action-versioning.md#major-versions).) + ## License This project is licensed under the MIT License - see the [LICENSE](https://github.com/stefanzweifel/git-auto-commit-action/blob/master/LICENSE) file for details.