Skip to content

Commit

Permalink
test automated pre-release
Browse files Browse the repository at this point in the history
  • Loading branch information
TGlide committed Aug 3, 2023
1 parent 3a07ebc commit 2d6f1b5
Show file tree
Hide file tree
Showing 4 changed files with 36 additions and 4 deletions.
6 changes: 6 additions & 0 deletions .changeset/ten-snakes-teach.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
---
"@appwrite.io/pink-icons": patch
"@appwrite.io/pink": patch
---

patch
5 changes: 1 addition & 4 deletions .github/workflows/release.yml
Original file line number Diff line number Diff line change
@@ -1,9 +1,6 @@
name: Release

on:
push:
branches:
- main
on: push

concurrency: ${{ github.workflow }}-${{ github.ref }}

Expand Down
23 changes: 23 additions & 0 deletions VERSIONING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
# Versioning

Versioning consists in 3 steps. Specifying a bump (which can be `patch`, `minor` or `major`), updating package versions, and releasing.

## Bumping

To specify a new bump in the package versions, you can use the `bump-x` script, where `x` is the bump type.

This will automatically generate a [changeset](https://github.com/changesets/changesets). A changeset is a file that contains the bump intent, and a list of all commits that will be included in the release.

## Updating package versions

To apply the bump intents, and change the package versions accordingly, you can use the `version` script. This will automatically update all the `CHANGELOG.md` files, and the `package.json` files.

## Releasing

If everything looks good, you can release the new version using the `release` script. This will automatically create a new git tag, and publish the packages to npm. Don't forget to commit!

## Pre-releasing

Sometimes, you will want to release a pre-release version. Firstly, be sure to be in a branch that is not `main`. Then, you can use the `pre` script, which will enter the current branch into pre-release mode. While in pre-release mode, all other actions are the same, but the version will be suffixed with `-next.X`.

Before merging this pre-release branch into `main`, be sure to exit the pre-release mode using the `pre` script again.
6 changes: 6 additions & 0 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,12 @@
"test": "turbo run test",
"format": "turbo run format",
"clean": "turbo run clean && rm -rf node_modules",
"pre": "",
"bump": "changeset",
"bump-patch": "",
"bump-minor": "",
"bump-major": "",
"version": "changeset version",
"release": "npm run build && changeset publish"
},
"devDependencies": {
Expand Down

0 comments on commit 2d6f1b5

Please sign in to comment.