Skip to content

Commit

Permalink
rename master to main
Browse files Browse the repository at this point in the history
  • Loading branch information
gabe committed Feb 21, 2023
1 parent 73c19f1 commit bf1f7ae
Show file tree
Hide file tree
Showing 3 changed files with 13 additions and 13 deletions.
4 changes: 2 additions & 2 deletions .github/workflows/release.yml
Original file line number Diff line number Diff line change
Expand Up @@ -3,10 +3,10 @@ name: Release
on:
push:
branches:
- master
- main

jobs:
push-master:
push-main:
# Only run on any commit that features the official release commit message syntax in the commit message.
if: "contains(github.event.head_commit.message, 'chore(ref-imp): official release')"
name: Build, test and publish stable release
Expand Down
4 changes: 2 additions & 2 deletions .github/workflows/unstable-release.yml
Original file line number Diff line number Diff line change
Expand Up @@ -3,10 +3,10 @@ name: Unstable Release
on:
push:
branches:
- master
- main

jobs:
push-master:
push-main:
# Only run if the push is not attempting to publish a release.
if: "! contains(github.event.head_commit.message, 'chore(ref-imp): official release')"
name: Build, test and publish unstable release
Expand Down
18 changes: 9 additions & 9 deletions docs/release-process.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,8 @@ The following document covers the release process for the artifacts in this repo
The following details the release process of the Sidetree reference implementation `@decentralized-identity/sidetree`, which is a typescript based [npm](https://www.npmjs.com/) package.

In general the release process can be summarized by the following flow
- Each merged pull request into master results in the automated release of a new unstable package on npm, unless the `[skip ci]` tag is included in the commit message.
- A release commit merged into master triggers a stable release of the reference implementation.
- Each merged pull request into main results in the automated release of a new unstable package on npm, unless the `[skip ci]` tag is included in the commit message.
- A release commit merged into main triggers a stable release of the reference implementation.

### Stable Releases

Expand All @@ -19,8 +19,8 @@ Checklist before creating a stable release:

To create a stable release follow the following steps:

1. Checkout the head of master `git checkout master && git pull`
1. Create a new release branch from master called `release`:
1. Checkout the head of main `git checkout main && git pull`
1. Create a new release branch from main called `release`:

`git checkout -b release`

Expand All @@ -35,9 +35,9 @@ To create a stable release follow the following steps:
1. Observe the triggering of the `/.github/workflows/release.yml` github workflow
1. Remove the tag created in the release branch: `git tag -d vX.Y.Z`
1. Remove the local release branch:
1. `git checkout master`
1. `git checkout main`
1. `git branch -D release`
1. Push a new version tag to remote master e.g. (v1.0.4):
1. Push a new version tag to remote main e.g. (v1.0.4):
1. git pull
1. git tag vX.Y.Z
1. git push origin vX.Y.Z
Expand All @@ -46,11 +46,11 @@ The resulting release will publish the new package to [npm](https://www.npmjs.co

### Unstable Releases

An unstable release is triggered on every commit to master, where the `/.github/workflows/push-master.yaml` is run.
An unstable release is triggered on every commit to main, where the `/.github/workflows/push-main.yaml` is run.

The releases have the following version syntax `<current package version + patch version>-unstable.<current git commit reference>`

**Note** The `/.github/workflows/push-master.yaml` will skip if the commit message includes `[skip ci]`
**Note** The `/.github/workflows/push-main.yaml` will skip if the commit message includes `[skip ci]`

**Note** To skip the automatic release of a new unstable version append `[skip ci]` to the end of the commit message
that is merged into master.
that is merged into main.

0 comments on commit bf1f7ae

Please sign in to comment.