oss/Radicale
oss/Radicale
1
0
Fork 0
mirror of https://github.com/Kozea/Radicale.git synced 2025-07-23 17:48:30 +00:00
Code Wiki Activity

add release process information

Peter Bieringer 2024-08-30 06:29:40 +02:00
parent 68e561d74e
commit 175fede4a2
2 changed files with 105 additions and 44 deletions
Download patch file Download diff file Expand all files Collapse all files

105
Development-Testing-Release.md Normal file

@ -0,0 +1,105 @@
# Development
(TODO)
# Testing
## Preparation
### Installation of test frameworks
* Fedora / Enterprise Linux
```bash
dnf install python3-pytest python-tox python-typeguard python-flake8
```
(TODO: other OS/distributions)
## Execution
Run in main source directory
### Directory Cleanup (optional)
Note: will remove everything untracked, even ignored
```bash
git clean -fdx
```
### Syntax check
```bash
flake8
```
### Complete test suite
Note: in case of strange errors add option `-r` for recreation of environment
```bash
tox
```
(more coming next)
# Release
## Verifications
* All last actions successfully executed
* CHANGELOG.md is up-to-date
* No important issues still pending
* Local repository is up-to-date: `git pull`
## Preparation
| File | Action |
|-|-|
| CHANGELOG.md | replace `3.dev` with `$VERSION` |
| setup.py | replace `3.dev` with `$VERSION` |
Commit changes
```
git commit -a
```
Create release tag
```
git tag v$VERSION
```
Push
```
git push
git push --tags
```
## Release
### Draft new release
* Release title: VERSION (depending on changes)
* Description: (copy part from CHANGELOG.md and sort by section)
* Set it as pre-release until EL/Fedora RPMs are build
Note: in case something needs to be corrected, create a new tag `v$VERSION-SEQ` and change tag of release
### Latest release
After RPMs are successfully built, mark it as latest release
## Turn back master to devel
| File | Action |
|-|-|
| CHANGELOG.md | replace `$VERSION` with `3.dev` |
| setup.py | replace `$VERSION` with `3.dev` |
Commit changes
```
git commit -a
```

44
Development-Testing.md

@ -1,44 +0,0 @@
# Development
(TODO)
# Testing
## Preparation
### Installation of test frameworks
* Fedora / Enterprise Linux
```bash
dnf install python3-pytest python-tox python-typeguard python-flake8
```
(TODO: other OS/distributions)
## Execution
Run in main source directory
### Directory Cleanup (optional)
Note: will remove everything untracked, even ignored
```bash
git clean -fdx
```
### Syntax check
```bash
flake8
```
### Complete test suite
Note: in case of strange errors add option `-r` for recreation of environment
```bash
tox
```
(more coming next)