Skip to content

Commit

Permalink
chore(readme): improve release documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
talo242 committed Apr 17, 2024
1 parent 7bd9c6d commit 5d9c8d5
Showing 1 changed file with 7 additions and 3 deletions.
10 changes: 7 additions & 3 deletions Readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,15 +6,19 @@ Collection of public models and utilities used at [Popsure](https://getpopsure.c

### Updating universities

You can update the universities file by running
You can update the universities file by running

```bash
node scripts/parseUniversities.js '<path to file>'
```

### Releasing a new version

1. Create a tag with the correct version number that follow the [Semantic Versioning](https://semver.org) standard (e.g. `git tag v27.0.0)
2. Use the "Draft a new release" on GitHub and write down some release notes containing "what's updated", "breaking change" (if any) and "Migration from previous version" (if any)
1. Go to the **Releases** section on GitHub and click on **Draft a new release**
2. On the **Choose a tag** dropdown, write down a new tag and click on **Create new tag on publish**. We
use [Semantic Versioning](https://semver.org) for versioning.
3. Write down some release notes containing "what's updated", "breaking change" (if any) and "Migration from previous
version" (if any)
4. Click on **Publish release**

GitHub Action will then automatically pick it up from there and release the new version for you.

0 comments on commit 5d9c8d5

Please sign in to comment.