Onionmine development

Onionmine development guidelines and workflow are listed here.

Release procedure

Release cycle workflow.

Version update

Set the version number:

ONIONMINE_VERSION=1.1.0

Update the version in some files, like:

$EDITOR lib/params
$EDITOR docker-compose.yml

Register the changes

Update the ChangeLog:

$EDITOR ChangeLog

Commit and tag:

git diff # review
git commit -a -m "Feat: Onionmine $ONIONMINE_VERSION"
git tag -s $ONIONMINE_VERSION -m "Onionmine $ONIONMINE_VERSION"

Push changes and tags. Example:

git push origin        && git push upstream
git push origin --tags && git push upstream --tags

Once a tag is pushed, a GitLab release is created.

Announcement

Announce the new release:

• Post a message to the Tor Forum, using the onion-services-announce tag.
• Send a message to the tor-announce mailing list ONLY in special cases, like important security issues (severity HIGH or CRITICAL).

Template:

Subject: [RELEASE] Onionmine [security] release $ONIONMINE_VERSION

Greetings,

We just released [Onionmine][] $ONIONMINE_VERSION, a tool for generating
Onion Service keys and TLS certificates.

[This release fixes a security issue. Please upgrade as soon as possible!]

[Onionmine]: https://onionservices.torproject.org/apps/web/onionmine

# ChangeLog

$CHANGELOG