Skip to content

Commit a611754

Browse files
committed
Chore: update readme
1 parent a4517c2 commit a611754

File tree

4 files changed

+22
-23
lines changed

4 files changed

+22
-23
lines changed

README.md

Lines changed: 2 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@
2727
Package for Ubuntu clients to connect to the linuxmuster.net 7 active directory server.
2828
This is the new version of the linuxmuster-client-adsso package.
2929
- For user documentation, take a look at the [wiki](https://github.com/linuxmuster/linuxmuster-linuxclient7/wiki).
30-
- For developer documentation, take a look at the [documentation](https://linuxmuster.github.io/linuxmuster-linuxclient7)
30+
- For developer documentation, take a look at the [documentation](https://linuxmuster.github.io/linuxmuster-linuxclient7).
3131

3232
## Maintenance Details
3333

@@ -39,25 +39,4 @@ Maintainer organisation | Linuxmuster.net
3939
Primary maintainer | dorian@itsblue.de
4040

4141
\* Even though this is not an official package, pull requests and issues are being looked at.
42-
** The linuxmuster community consists of people who are nice and happy to help. They are not directly involved in the development though, and might not be able to help in any case.
43-
44-
## Version schema:
45-
- General: `major.minor.patch`
46-
- Pre-releases (release candidates) must end with `-rcXX` where `XX` is the number of the pre-release
47-
- So, before version `7.1.1` is released, there may be versions `7.1.1-rc01`, `7.1.1-rc02`, and so on
48-
- Releases are always prefixed with `release`.
49-
- So, once version `7.1.1` is ready, it is published as `7.1.1-release`
50-
- This concept ensures that stable releases are always evaluated as a higher version number than pre-releases.
51-
52-
## Setup development environment
53-
54-
Tested with Python 3.10:
55-
56-
1. `python3 -m venv ./venv`
57-
2. `. ./venv/bin/activate`
58-
3. `cd ./usr/lib/python3/dist-packages/linuxmusterLinuxclient7`
59-
4. `pip install -r requirements.txt`
60-
61-
To run tests:
62-
1. `pytest`
63-
2. with coverage: `pytest --cov=./ --cov-report=xml`
42+
** The linuxmuster community consists of people who are nice and happy to help. They are not directly involved in the development though, and might not be able to help in any case.

wiki/Development/Creating-a-release.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,11 @@
1+
### Version schema:
2+
- General: `major.minor.patch` ([semver](https://semver.org/))
3+
- Pre-releases (release candidates) must end with `~XX` where `XX` is the number of the pre-release
4+
- So, before version `7.1.1` is released, there may be versions `7.1.1~01`, `7.1.1~02`, and so on
5+
- Releases don't have a suffix.
6+
- So, once version `7.1.1` is ready, it is published as `7.1.1`
7+
- This concept ensures that stable releases are always evaluated as a higher version number than pre-releases.
8+
19
### The following steps have to be followed to create a release:
210
1. Update the changelog file
311
3. commit all changes
Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
### Setup
2+
Setup development environment for running unit test locally (Tested with Python 3.10):
3+
4+
1. `python3 -m venv ./venv`
5+
2. `. ./venv/bin/activate`
6+
3. `cd ./usr/lib/python3/dist-packages/linuxmusterLinuxclient7`
7+
4. `pip install -r requirements.txt`
8+
9+
To run tests:
10+
1. `pytest`
11+
2. with coverage: `pytest --cov=./ --cov-report=xml`

wiki/_Sidebar.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,5 +21,6 @@
2121
[Logon error messages](Logon-error-messages)
2222

2323
# Development
24+
[Running unittests](Running-Unittests)
2425
[Creating a release](Creating-a-release)
2526
[Live testing](Live-testing)

0 commit comments

Comments
 (0)