Skip to content

Commit 37cc677

Browse files
committed
Update repo docs
1 parent df6fe35 commit 37cc677

1 file changed

Lines changed: 22 additions & 7 deletions

File tree

MAINTAINERS.md

Lines changed: 22 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -87,7 +87,9 @@ We name bugfixes as "bugfix/ISSUENUMBER_shortname"; features are named "feature/
8787
Cutting a New Release
8888
=====================
8989

90-
Releases for dpath occur automatically from travis-ci based on tags on the master branch, or on the version/[0-9].x branches for major version LTS.
90+
Releases for dpath occur automatically from Github Actions based on version changes on the master branch.
91+
92+
Due to legacy reasons older tag names do not follow a uniform format:
9193

9294
akesterson@akesterson:~/dpath-python$ git tag
9395
1.0-0
@@ -108,18 +110,31 @@ Releases for dpath occur automatically from travis-ci based on tags on the maste
108110
build,1.5,0
109111
build,2.0,0
110112

111-
Once upon a time, the version string was automatially computed based on the content of these tags. Now, however, the version string is stored statically in dpath/version.py
113+
Moving forward version numbers and tag names will be identical and follow the standard semver format.
114+
115+
The version string is stored in `dpath/version.py` and tag names/release versions are generated using this string.
112116

113117
akesterson@akesterson:~/dpath-python$ cat dpath/version.py
114118
VERSION = "2.0.0"
115119

116120
To cut a new release, follow this procedure:
117121

118-
1. Commit a new dpath/version.py on the appropriate branch with the format "MAJOR.MINOR.RELEASE"
119-
2. Add a new tag of the form "build,MAJOR.MINOR,RELEASE" to the appropriate branch. This tag must have the same version number as the one commmited in dpath/version.py or we will fill your desk drawers with cockroaches.
120-
3. Push the new branch version and the associated tag to github.
121-
4. travis-ci SHOULD push the new release to pypi.
122+
1. Commit a new `dpath/version.py` on the appropriate branch with the format "MAJOR.MINOR.RELEASE".
123+
2. Github Actions SHOULD push the new release to PyPI on merge to `master`.
122124

123-
If travis-ci fails to update pypi, follow the instructions on manually creating a release, here:
125+
See `.github/workflows/deploy.yml` for more information.
126+
127+
If the Github workflow fails to update pypi, follow the instructions on manually creating a release, here:
124128

125129
https://packaging.python.org/tutorials/packaging-projects/#uploading-the-distribution-archives
130+
131+
Running Tests
132+
=============
133+
134+
Tests are managed using [tox](https://tox.readthedocs.io/en/latest/).
135+
136+
Environment creation and dependency installation is managed by this tool, all one has to do is install it with `pip` and run `tox` in this repo's root directory.
137+
138+
Tests can also be run with Github Actions via the [tests.yml](https://github.com/dpath-maintainers/dpath-python/actions/workflows/tests.yml) workflow.
139+
140+
This workflow will run automatically on pretty much any commit to any branch of this repo but manual runs are also available.

0 commit comments

Comments
 (0)