Commit 588406f7 authored by Silvio Rhatto's avatar Silvio Rhatto
Browse files

Merge branch 'feat/first-release' into 'main' 

Onionmine 1.0.0 (#28)

See merge request !29
parents 3ddf146a 424b9171

ChangeLog.md

0 → 120000
+1 −0
Original line number Diff line number Diff line 
docs/changelog.md
 
 No newline at end of file

docs/.pages

+2 −0
Original line number Diff line number Diff line
@@ -2,6 +2,8 @@ nav: 
  - Intro: README.md

  - Usage: usage.md

  - Security: security.md

  - ChangeLog: changelog.md

  - Alternatives: alternatives.md

  - Development: development.md

  - References: references.md

  - Contact and bug reporting: contact.md

docs/changelog.md

0 → 100644
+5 −0
Original line number Diff line number Diff line 
# Onionmine ChangeLog



## 1.0.0 - 2025-03-20



* First release.

docs/development.md

0 → 100644
+69 −0
Original line number Diff line number Diff line 
# Onionmine development



Onionmine development guidelines and workflow are listed here.



## Release procedure



Release cycle workflow.



### Version update



Set the version number:



    ONIONMINE_VERSION=1.0.0



Update the version in some files, like:



    $EDITOR lib/params



### 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.



[GitLab release]: https://docs.gitlab.com/ee/user/project/releases/



### 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

```



[tor-announce]: https://lists.torproject.org/cgi-bin/mailman/listinfo/tor-announce

[Tor Forum]: https://forum.torproject.org

[onion-services-announce tag]: https://forum.torproject.org/tag/onion-services-announce

docs/security.md

+1 −1
Original line number Diff line number Diff line
@@ -93,7 +93,7 @@ passphrases to be used][skipnear] when this incrementing happens. 


    Make sure to always pass `--skipnear` when invoking [mkp224o][].



    This is the default on Onionmine since 2025-03-20.

    This is the default on Onionmine since version 1.0.0 (2025-03-20).



[skipnear]: https://github.com/cathugger/mkp224o/issues/101