Skip to content

Commit

Permalink
Add doc about changelog and versioning
Browse files Browse the repository at this point in the history
  • Loading branch information
Vadorequest committed Dec 30, 2020
1 parent 7ebc988 commit c6e05bc
Show file tree
Hide file tree
Showing 2 changed files with 29 additions and 1 deletion.
4 changes: 3 additions & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
CHANGELOG
===

v1
Please visit [our releases page](https://github.com/UnlyEd/github-action-await-vercel/releases).

Each release is automatic, using the workflow [`.github/workflows/auto-git-release.yml`](https://github.com/UnlyEd/github-action-await-vercel/blob/main/.github/workflows/auto-git-release.yml).
26 changes: 26 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -176,6 +176,32 @@ Then, you'll need to create and add your own Vercel token there (`VERCEL_TOKEN`)

---

# Changelog
[Changelog](./CHANGELOG.md)

---

# Releases versioning
We follow Semantic Versioning. (`major.minor.patch`)

Our versioning process is completely automated, any changes landing on the `main` branch will trigger a new [release](https://github.com/UnlyEd/github-action-await-vercel/releases).

- `MAJOR`: Behavioral change of the existing API that would result in a breaking change.
- E.g: Removing an input, or changing the output would result in a breaking change and thus would be released as a new MAJOR version.
- `Minor`: Behavioral change of the existing API that would **not** result in a breaking change.
- E.g: Adding an optional input would result in a non-breaking change and thus would be released as a new Minor version.
- `Patch`: Any other change.
- E.g: Documentation, tests, refactoring, bug fix, etc.

## Releases versions:
- We do not provide major versions that are automatically updated (e.g: `v1`).
- We only provide tags/releases that are not meant to be changed once released (e.g: `v1.1.0`).

> As utility, we provide a special [`latest`](https://github.com/UnlyEd/github-action-await-vercel/releases/tag/latest) tag which is automatically updated to the latest release.
> _This tag/release is **not meant to be used in production systems**, as it is not reliable (might jump to the newest MAJOR version at any time)._

---

# License
[MIT](./LICENSE)

Expand Down

0 comments on commit c6e05bc

Please sign in to comment.