novaburst/funquail
1
0
Fork 0
Code Issues Pull requests Releases Wiki Activity

chore: format files using prettier (pre-commit)

Browse source
This commit is contained in:
jo 2022-11-23 22:42:32 +01:00
commit 6d7dc2f1b5
No known key found for this signature in database
GPG key ID: B2FEC9B22722B984
87 changed files with 4496 additions and 5178 deletions
Download patch file Download diff file Expand all files Collapse all files

80
docs/developer_documentation/workflows/release.md
View file

@ -4,75 +4,75 @@ Once we're ready to release a new version of the software, we can use the follow
1. Export the new release version
```sh
export NEXT_RELEASE=1.3.0
```
```sh
export NEXT_RELEASE=1.3.0
```
2. Export the previous release version
```sh
export PREVIOUS_RELEASE=1.2.9
```
```sh
export PREVIOUS_RELEASE=1.2.9
```
3. Pull the latest version of the `develop` branch. Use `stable` if you're releasing a bugfix.
::::{tab-set}
::::{tab-set}
:::{tab-item} Bugfix release
:sync: bugfix
:::{tab-item} Bugfix release
:sync: bugfix
```sh
git checkout stable
git pull
```
```sh
git checkout stable
git pull
```
:::
:::
:::{tab-item} Feature release
:sync: feature
:::{tab-item} Feature release
:sync: feature
```sh
git checkout develop
git pull
```
```sh
git checkout develop
git pull
```
:::
:::
::::
::::
4. Compile the changelog
```sh
towncrier build --version $NEXT_RELEASE
```
```sh
towncrier build --version $NEXT_RELEASE
```
5. Check the output and fix typos and mistakes
6. Add a list of contributors
```sh
python3 scripts/get-contributions-stats.py $NEXT_RELEASE # Output a list of contributors
git log $PREVIOUS_RELEASE.. --format="- %aN" --reverse | sort | uniq # Get a list of all commit authors
nano CHANGELOG # Add these lists to the CHANGELOG
```
```sh
python3 scripts/get-contributions-stats.py $NEXT_RELEASE # Output a list of contributors
git log $PREVIOUS_RELEASE.. --format="- %aN" --reverse | sort | uniq # Get a list of all commit authors
nano CHANGELOG # Add these lists to the CHANGELOG
```
7. Update the `__version__` variable to the next release version
```sh
nano api/funkwhale_api/__init__.py
```
```sh
nano api/funkwhale_api/__init__.py
```
8. Commit all changes
```sh
git add .
git commit -m "Version bump and changelog for $NEXT_RELEASE"
```
```sh
git add .
git commit -m "Version bump and changelog for $NEXT_RELEASE"
```
9. Create a tag
```sh
git tag $NEXT_RELEASE
```
```sh
git tag $NEXT_RELEASE
```
10. Publish the new tag to GitLab