Skip to content

Commit

Permalink
Update doc
Browse files Browse the repository at this point in the history
  • Loading branch information
Vadorequest committed Jan 10, 2023
1 parent df4842c commit ec29451
Showing 1 changed file with 6 additions and 3 deletions.
9 changes: 6 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -246,9 +246,9 @@ While those options can be useful, we intend to give some "production-grade" bes

- **Do NOT use `@latest` for production**, ever. While only "supposed-to-be-stable" versions will be tagged
as `@latest`, it could harbor bugs nonetheless.
- You can use auto-upgrading major version, such as `@v1`, but this is not a best practice, see our explanations below.
- You can use auto-upgrading major version, such as `@v1` or `@v1.2`, but this is not always the best practice, see our explanations below.

### Special tags and production-grade apps best practices
### Special tags and best practices for production-grade apps

Here are a few useful options you can use to pin a more-or-less specific version of our GitHub Action, alongside some "
production-grade" best practices.
Expand All @@ -260,6 +260,9 @@ production-grade" best practices.
- `@{MAJOR}`, e.g: `@v1`, can be used on production, but we do not advise to do so (SAFE-ISH)
- `@{MAJOR}-rc`, e.g: `@v1-rc`, **reserved for development mode**, useful when debugging on a specific prerelease
version (UNSAFE)
- `@{MAJOR}.{MINOR}`, e.g: `@v1.2`, can be used on production, but we do not advise to do so (SAFE-ISH)
- `@{MAJOR}.{MINOR}-rc`, e.g: `@v1.2-rc`, **reserved for development mode**, useful when debugging on a specific prerelease
version (UNSAFE)
- `@latest`, **reserved for development mode**, useful when debugging (UNSAFE)

**"But, what is the issue with the `@{MAJOR}-{MINOR}-{PATCH}` way to pin a specific version"?**
Expand All @@ -271,7 +274,7 @@ That's why **pinning a specific commit SHA is the only truly safe option**. This
changed against your will**.

Most people won't care about this and will use a MAJOR version tag instead anyway, such as `@v1`. It's common, but not
the best practice.
often the best practice.

It all comes down to the risks you're ready to take, and it's up to you to decide what's best in your situation.

Expand Down

0 comments on commit ec29451

Please sign in to comment.