Skip to content

Commit

Permalink
Documenting the release process. (#24)
Browse files Browse the repository at this point in the history
* Documenting the release process.

* Rename creating-a-release to creating-a-release.md

* Update docs/development/creating-a-release.md

* Update docs/development/creating-a-release.md

* Update docs/development/creating-a-release.md

* Add to summary

* Update docs/development/creating-a-release.md

Co-authored-by: Jordi Sala Morales <[email protected]>

* Change release end

Co-authored-by: Jordi Sala Morales <[email protected]>
  • Loading branch information
eddsaura and jordisala1991 authored Aug 4, 2022
1 parent b6eee30 commit f79fb12
Show file tree
Hide file tree
Showing 2 changed files with 52 additions and 0 deletions.
2 changes: 2 additions & 0 deletions SUMMARY.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@
* [Development][development]
* [Setup and run development environment][setup-environment]
* [Structure][structure]
* [Creating a release][creating-a-release]
* [How to update Jitsi Meet Library?][update-jitsi-lib]
* [How to update the API Platform autogenerated types?][update-api-platform-types]

Expand All @@ -17,5 +18,6 @@
[setup-environment]: docs/development/setup-environment.md
[structure]: docs/development/structure.md
[update-jitsi-lib]: docs/development/update-jitsi-lib.md
[creating-a-release]: docs/development/creating-a-release.md
[update-api-platform-types]: docs/development/update-api-platform-types.md
[translations]: docs/contributing/translations.md
50 changes: 50 additions & 0 deletions docs/development/creating-a-release.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,50 @@
# Creating a release

You will need to have the project on your computer and NPM installed.

## How to create a release?

The whole process summarized

- Get all the PRs since last release.
- Create a new branch with the updated version and changelog for the team to review.
- Create Github release.
- Release it 🎉

### Get the PRs
We are using [auto-changelog](https://github.com/cookpete/auto-changelog) to gather all the changes made from release to release.

First we will need to update the version in the `/package.json` (the one in root directory) to corresponding version.

Then get the name of the Stooa's remote repo in your config. In our case is `upstream` because this is how we named it.

To check yours run
```batch
git remote -v
```
And make sure you use the Stooa repo, not your fork.


Then, once we know the remote name, we get all the PRs since last release and update the `changelog.md` in the project just running

```batch
npx auto-changelog --remote=[name_of_your_remote]
```

This command will output our updated `CHANGELOG.md`

### Create new Release branch

Now create the new branch to push all the changes made to the changelog. This way the team could review that everything is correct to approve it!

Naming convention is `release/[number_of_release]`, so if you are releasing the version 2.8.8 it should be `release/2.8.8`.
### Create Github release

Once the PR is approved and merged, we head to [github releases](https://github.com/Stooa/Stooa/releases) to create a new one with the same number in the tag release we previously used in the `package.json`.

The content of the release will be the last changes in the `CHANGELOG.md`

### Release 🎉
After filling all the data just hit Publish release!

Well done, you've made a Stooa release 😄

0 comments on commit f79fb12

Please sign in to comment.