Skip to content

Commit 249807b

Browse files
committed
add current release procedure howto
1 parent 4570ebf commit 249807b

File tree

1 file changed

+58
-0
lines changed

1 file changed

+58
-0
lines changed

howto/release.md

Lines changed: 58 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,58 @@
1+
Testing:
2+
3+
```sh
4+
python -m moarchiving.test
5+
ruff check --ignore F401 --ignore E722 --ignore E741 moarchiving
6+
```
7+
8+
Final final changes to version numbers etc.:
9+
10+
```sh
11+
__init__.py # edit version number
12+
# not applicable: tools/conda.recipe/meta.yaml # edit version number
13+
moarchiving.ipynb # add release description
14+
README.md + .html # created from moarchiving.ipynb, see howto/update_readme.md
15+
merge development branch to master if necessary
16+
```
17+
18+
To prepare a distribution from a dirty code folder:
19+
20+
```sh
21+
# CAVEAT: backup is also a homebrew minitool (not meant here)
22+
backup install-folder --move
23+
backup moarchiving --move
24+
mkdir install-folder
25+
git checkout -- moarchiving
26+
cp -r moarchiving pyproject.toml LICENSE install-folder
27+
backup --recover # recover last above moved folder (and backup current, just in case)
28+
```
29+
30+
Make distribution
31+
32+
```sh
33+
cd install-folder
34+
python -c "open('README.md', 'w').write(open('../README.md', 'r').read().split('### 11')[0])"
35+
python -m build > dist_call_output.txt
36+
less dist_call_output.txt # not very informative
37+
ll dist # just checking creation date
38+
tar -tf dist/moarchiving-1.0.0.tar.gz | tree --fromfile # check that the distribution folders are clean
39+
```
40+
41+
Check distribution and project description:
42+
43+
```sh
44+
twine check dist/* # install/update/upgrade pkginfo if this fails
45+
cp dist/* ../dist
46+
```
47+
48+
Copy changes in install-folder to root folder and commit (not clear how exactly, Diff Folders may help).
49+
50+
Finally, upload the distribution:
51+
52+
```sh
53+
twine upload dist/*1.0.x* # to not upload outdated stuff
54+
```
55+
56+
With `setuptools_scm`:
57+
58+
-> expected: ERROR setuptools_scm._file_finders.git listing git files failed - pretending there aren't any

0 commit comments

Comments
 (0)