diff --git a/auto-commit/README.md b/auto-commit/README.md index b1ad541..9187e5b 100644 --- a/auto-commit/README.md +++ b/auto-commit/README.md @@ -1,5 +1,7 @@ # Auto-commit GitHub Action +**Note:** You need to use the actions/checkout@**v2** for this action to work. See [#23](https://github.com/cds-snc/github-actions/issues/23) for more info. + The purpose of this GitHub action is to auto-commit back any changes made to the branch through previous GitHub actions. This allows you to export build scripts into GitHub Actions. GitHub appears to be smart enough not to run CI on commits made by a GitHub action. ![screen shot 2019-02-19 at 9 06 03 am](https://user-images.githubusercontent.com/867334/53020783-b2389e00-3425-11e9-8d05-273c5e8f7d1d.png)