diff --git a/Development-Testing-Release.md b/Development-Testing-Release.md new file mode 100644 index 0000000..2969d0a --- /dev/null +++ b/Development-Testing-Release.md @@ -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 +``` diff --git a/Development-Testing.md b/Development-Testing.md deleted file mode 100644 index c6e219b..0000000 --- a/Development-Testing.md +++ /dev/null @@ -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) \ No newline at end of file