-
-
Notifications
You must be signed in to change notification settings - Fork 93
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
improve package release docs to include signed releases; fixes #312
- Loading branch information
1 parent
ab2353c
commit a8cad88
Showing
1 changed file
with
53 additions
and
18 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -530,31 +530,33 @@ there may be an occasional need to access the moin shell directly:: | |
source <path-to-venv>/bin/activate # or ". activate" windows: "activate" | ||
moin -h # show help | ||
|
||
Package Release on test.pypi.org | ||
================================ | ||
|
||
This procedure for updating test.pypi avoids adding release tags to master branch, | ||
hoping that someday there will be a real 2.0.0a1. Current state | ||
of moin 2 is pre-alpha. | ||
|
||
Commit or stash all versioned changes. Pull all updates from master repo. Create a release branch. | ||
Run `./m quickinstall` to update the venv and translations. Run tests. | ||
Add a tag with the next release number to the release branch:: | ||
|
||
git tag 2.0.0a14 | ||
|
||
Install or upgrade release tools:: | ||
Package Release on pypi.org and Github Releases | ||
=============================================== | ||
|
||
* Commit or stash all versioned changes. | ||
* Pull all updates from master repo. | ||
* Run `./m quickinstall` to update the venv and translations. | ||
* Run tests. | ||
* Add a signed, annotated tag with the next release number to master branch:: | ||
|
||
git tag -s 2.0.0a1 -m "alpha release" | ||
|
||
* Install or upgrade release tools:: | ||
|
||
pip install --upgrade setuptools wheel | ||
pip install --upgrade twine | ||
pip install --upgrade build | ||
|
||
Build the distribution and upload to test.pypi.org:: | ||
* Build the distribution and upload to pypi.org:: | ||
|
||
py -m build > build.log 2>&1 # check build.log for errors | ||
py -m twine upload --repository testpypi dist/* | ||
py -m twine upload dist/* | ||
|
||
Enter ID and password as requested. | ||
* Enter ID and password or API Token as requested. | ||
|
||
Test Build | ||
---------- | ||
|
@@ -563,17 +565,50 @@ Create a new venv, install moin, create instance, start server, create item, mod | |
|
||
<python> -m venv </path/to/new/virtual/environment> | ||
cd </path/to/new/virtual/environment> | ||
source bin/activate # scripts\activate | ||
pip install --upgrade pip # next command fails with pip 9.0.1 and maybe later versions | ||
pip install --pre --index-url https://test.pypi.org/simple --extra-index-url https://pypi.org/simple moin | ||
source bin/activate # or "scripts\activate" on windows | ||
pip install --pre moin | ||
moin --help # prove it works | ||
# update wikiconfig.py # default allows read-only, admins may load data | ||
moin create-instance --path <path/to/new/wikiconfig/dir> # path optional, defaults to CWD | ||
cd <path/to/new/wikiconfig/dir> # skip if using default CWD | ||
moin index-create | ||
moin run # empty wiki | ||
|
||
moin run # empty wiki, or do | ||
moin welcome # load welcome pages (e.g. Home) | ||
moin load-help -n help-en # load English help | ||
moin load-help -n help-common # load help images | ||
moin run # wiki with English help and welcome pages | ||
|
||
Announce update on #moin, [email protected]. | ||
Continue with Package Release | ||
----------------------------- | ||
|
||
Push the signed, annotated tag created above to github master:: | ||
|
||
git push moinwiki 2.0.0a1 | ||
|
||
Create an ASCII-format detached signature named moin-2.0.0a1.tar.gz.asc:: | ||
|
||
cd dist | ||
gpg --detach-sign -a moin-2.0.0a1.tar.gz | ||
cd .. | ||
|
||
Follow the instructions here to update GitHub; drag & drop moin-2.0.0a1.tar.gz | ||
and moin-2.0.0a1.tar.gz.asc to upload files area. These files serve as | ||
a backup for the release sdist and the signature, so anybody can | ||
verify the sdist is authentic:: | ||
|
||
https://docs.github.com/en/repositories/releasing-projects-on-github/managing-releases-in-a-repository | ||
|
||
Test the GitHub Release package:: | ||
|
||
<python> -m venv </path/to/new/virtual/environment> | ||
cd </path/to/new/virtual/environment> | ||
source bin/activate # or "scripts\activate" on windows | ||
pip install git+https://github.com/moinwiki/[email protected] | ||
moin --help # prove it works | ||
|
||
Announce update on #moin, [email protected], [email protected]:: | ||
|
||
Moinmoin 2.0.0a1 has been released on https://pypi.org/project/moin/#history | ||
and https://github.com/moinwiki/moin/releases. See https://moin-20.readthedocs.io/en/latest/, | ||
use https://github.com/moinwiki/moin/issues to report bugs. |