From 92e992b198447bb1f86dda964de6ff1f06a54b77 Mon Sep 17 00:00:00 2001 From: Shivam Mathur Date: Sat, 23 Sep 2023 04:32:24 +0530 Subject: [PATCH] Update versioning section in the README --- README.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 06937d45..3ab23a7d 100644 --- a/README.md +++ b/README.md @@ -940,7 +940,8 @@ Examples of using `setup-php` with various PHP frameworks and packages. - Use the `v2` tag as `setup-php` version. It is a rolling tag and is synced with the latest minor and patch releases. With `v2` you automatically get the bug fixes, security patches, new features and support for latest PHP releases. - Semantic release versions can also be used. It is recommended to [use dependabot](https://docs.github.com/en/github/administering-a-repository/keeping-your-actions-up-to-date-with-github-dependabot "Setup Dependabot with GitHub Actions") with semantic versioning to keep the actions in your workflows up to date. -- Commit SHA can also be used, but are not recommended. They have to be updated with every release manually, without which you will not get any bug fixes, security patches or new features. +- Commit SHA can also be used, but are not recommended unless you set up tooling to update them with each release of the action. +- A new major version of the action will only be tagged when there are breaking changes in the setup-php API i.e. inputs, outputs, and environment flags. - For debugging any issues `verbose` tag can be used temporarily. It outputs all the logs and is also synced with the latest releases. - It is highly discouraged to use the `main` branch as version, it might break your workflow after major releases as they have breaking changes. - If you are using the `v1` tag or a `1.x.y` version, you should [switch to v2](https://github.com/shivammathur/setup-php/wiki/Switch-to-v2 "Guide for switching from setup-php v1 to v2") as `v1` only gets critical bug fixes. Maintenance support for `v1` will be dropped with the last `PHP 8.0` release.