summaryrefslogtreecommitdiff
path: root/admin/README.md
blob: 23152dd875b98bd955aa3b4a2299574144ccb393 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
# Admin Tools

Tools to assist with RDFlib releases, like extracting all merged PRs from GitHub since last release.


## Release procedure

1. merge all PRs for the release
2. pass all tests
    * `python run_tests.py`
3. black everything 
    * use the config, e.g. `black --config black.toml .` in main dir
4. build docs - check for errors/warnings there
    * `python setup.py build_sphinx`
5. alter version & date in rdflib/__init__.py
6. update:
    * CHANGELOG.md
    * CONTRIBUTORS
        * use scripts here to generate "PRs since last release"
        * LICENSE (the date)
    * setup.py (the long description)
7. update admin steps (here)
8. push to PyPI
    * `pip3 install twine wheel`
    * `python3 setup.py bdist_wheel sdist`
    * `twine upload ./dist/*`
9. Make GitHub release
    * `git tag <new-version>`
    * `git push --tags`
    * go to the tagged version, e.g. https://github.com/RDFLib/rdflib/releases/tag/6.0.0
    * edit the release' notes there (likely copy from CHANGELOG)
11. Build readthedocs docco
    * `latest` and `stable` need to be built at least
    * best to make sure the previous (outgoing) release has a number-pegged version, e.g. 5.0.0
12. update the rdflib.dev website page
14. Update the GitHub master version
    * e.g. for release 6.0.2, change version to 6.0.3a and push to GitHub