Skip to content

Commit

Permalink
fix(docs): added publishing info
Browse files Browse the repository at this point in the history
  • Loading branch information
stefan-lacatus committed Mar 20, 2020
1 parent b41ff88 commit 77f4ff2
Showing 1 changed file with 13 additions and 0 deletions.
13 changes: 13 additions & 0 deletions CONTRIBUITING.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,3 +24,16 @@ The forked version of monaco-typescript adds support for declaring new languages
yarn run build
```
7. In the zip folder, you should have the built version of the extension.

## Publishing a new release to github

The widget uses [semantic-release](https://semantic-release.gitbook.io/) and GitHub Actions for automatic version management and package publishing. This automates the whole widget release workflow including: determining the next version number, generating the release notes, updating the _CHANGELOG.MD_ and publishing a release. Please read through the *semantic-release* official documentation to better understand how it works.

Because we are using *semantic-release* the commit messages must follow a specific format called [Angular commit conventions or Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/). It is mandatory that this is followed. To help with this, the project is also setup with [commitizen](https://commitizen.github.io/cz-cli/) as a dev-dependency. So, you can use `git cz` instead of `git commit` to create a new commit.

The repository has two branches:

* **master**: This is where the main development takes place.
* **release**: The branch containing the latest release of the widget. Pushing to this branch triggers the `semantic-release`, updating the *CHANGELOG.MD* file, and creating a new GitHub release.

To create a new release, simply merge **master** into **release** and push the changes to github. An action will automatically be triggered.

0 comments on commit 77f4ff2

Please sign in to comment.