Skip to content

Commit

Permalink
Merge pull request #27 from fish-shop/readme
Browse files Browse the repository at this point in the history
Add tip alert to README.md
  • Loading branch information
marcransome authored Dec 29, 2023
2 parents 2b535ba + d0122e1 commit ffe8c07
Showing 1 changed file with 2 additions and 1 deletion.
3 changes: 2 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,8 @@ Use one of the following patterns when specifying the version reference for this
| `vX.Y` | `v1.1` | the latest `v1.1.*` release including bug fixes |
| `vX.Y.Z` | `v1.1.0` | the `v1.1.0` release only |

The recommended pattern is `vX` (e.g. `v1`). This will ensure that the version of the action used in your workflow includes the latest non-breaking changes and bug fixes, and guarantees compatibility with previous versions of that major release number.
> [!TIP]
> The recommended pattern is `vX` (e.g. `v1`). This will ensure that the version of the action used in your workflow includes the latest non-breaking changes and bug fixes, and guarantees compatibility with previous versions of that major release number.

Using a `main` branch reference in your workflow is _not_ recommended as this branch may include breaking changes intended for the next major release.

Expand Down

0 comments on commit ffe8c07

Please sign in to comment.