Skip to content

Commit

Permalink
docs(var): build and version
Browse files Browse the repository at this point in the history
  • Loading branch information
nopeitsnothing committed Jul 27, 2024
1 parent 3c0a8ca commit 8da97cf
Show file tree
Hide file tree
Showing 217 changed files with 14,985 additions and 40,690 deletions.
4 changes: 4 additions & 0 deletions .cz.toml
Original file line number Diff line number Diff line change
@@ -1,7 +1,11 @@
[tool.commitizen]
bump_message = "release $current_version → $new_version []"
annotated_tag = true
update_changelog_on_bump = true
changelog_incremental = true
changelog_start_rev = "v0.4.7"
gpg_sign = true
allow_abort = true
version_files = [
"_layouts/default.html:Version"
]
12 changes: 12 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
# Author.: Anonymous Planet
# License.: CC BY-NC 4.0

# Minimize global Ruby .gitignore
_site/
.sass-cache/
Expand All @@ -7,3 +10,12 @@ _site/
.cache/
vendor/
Gemfile*

# Artifact from PDF tests
*.log

# Linters
megalinter-reports/

# CZ
.cz.toml
2 changes: 1 addition & 1 deletion .pre-commit-config.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -13,4 +13,4 @@ repos:
stages:
- push
repo: https://github.com/commitizen-tools/commitizen
rev: v3.27.0
rev: v3.28.0
1,803 changes: 902 additions & 901 deletions CHANGELOG.md

Large diffs are not rendered by default.

7 changes: 0 additions & 7 deletions CHANGELOG.md.asc

This file was deleted.

4 changes: 0 additions & 4 deletions CHANGELOG.md.minisig

This file was deleted.

7 changes: 0 additions & 7 deletions CODE_OF_CONDUCT.md.asc

This file was deleted.

4 changes: 0 additions & 4 deletions CODE_OF_CONDUCT.md.minisig

This file was deleted.

7 changes: 0 additions & 7 deletions CONTRIBUTING.md.asc

This file was deleted.

4 changes: 0 additions & 4 deletions CONTRIBUTING.md.minisig

This file was deleted.

63 changes: 32 additions & 31 deletions KEY_ROTATION.md
Original file line number Diff line number Diff line change
@@ -1,31 +1,32 @@
PGP/GPG key ID `7DFFD7471FB76E2A8ABBBCDDD769B3749E933B8A` is no longer active
PGP/GPG key ID `42FF35DB9DE7C088AB0FD4A70C216A52F6DF4920` is no longer active

This project now uses separate master, release signing, and email keys.

Current master key fingerprint: `9EA98278639F1CD853E096CBFF94507587A6A9B9`
Current release key fingerprint: `83A6CF9EF57AC25B5C7F5D29285E6048A12321B2`
Current email key fingerprint: `B6D1757632A280F99F2DCBFDB9AB9D93AFF05B9C`

The email and release keys should be signed by the master key.
The master key takes precedence over all other project keys.
------------------------------------------------------------------------------------
Minisign key
```
untrusted comment: minisign public key 902835EC74825934
RWQ0WYJ07DUokK8V/6LNJ9bf/O/QM9k4FSlDmzgEeXm7lEpw3ecYjXDM
```
is no longer active

Use
```
untrusted comment: minisign public key FE6A09A3AF18F7A7
RWSn9xivowlq/ihAzclDBxhCxbYz4bLkC8E645lHgSUlQNlDvoTxO5Fv
```
instead

Files signed using this key pair can be verified with the following command:

```
minisign -Vm <file> -P RWSn9xivowlq/ihAzclDBxhCxbYz4bLkC8E645lHgSUlQNlDvoTxO5Fv
```
PGP/GPG key ID `7DFFD7471FB76E2A8ABBBCDDD769B3749E933B8A` is no longer active
PGP/GPG key ID `42FF35DB9DE7C088AB0FD4A70C216A52F6DF4920` is no longer active
PGP/GPG key ID `9EA98278639F1CD853E096CBFF94507587A6A9B9` is no longer active

This project now uses separate master, release signing, and email keys.

Current master key fingerprint: `9FA5436D0EE360985157382517ECA05F768DEDF6`
Current release key fingerprint: `C3023DBEA3FB38C438BA1EEDCEC60AEDE8B992A2`
Current email key fingerprint: `FCBD2CABDEFD1FBA2E9E7591A1A82CD2DD2CF890`

The email and release keys should be signed by the master key.
The master key takes precedence over all other project keys.
------------------------------------------------------------------------------------
Minisign key
```
untrusted comment: minisign public key 902835EC74825934
RWQ0WYJ07DUokK8V/6LNJ9bf/O/QM9k4FSlDmzgEeXm7lEpw3ecYjXDM
```
is no longer active

Use
```
untrusted comment: minisign public key FE6A09A3AF18F7A7
RWSn9xivowlq/ihAzclDBxhCxbYz4bLkC8E645lHgSUlQNlDvoTxO5Fv
```
instead

Files signed using this key pair can be verified with the following command:

```
minisign -Vm <file> -P RWSn9xivowlq/ihAzclDBxhCxbYz4bLkC8E645lHgSUlQNlDvoTxO5Fv
```
31 changes: 0 additions & 31 deletions KEY_ROTATION.md.asc

This file was deleted.

4 changes: 0 additions & 4 deletions KEY_ROTATION.md.minisig

This file was deleted.

7 changes: 0 additions & 7 deletions LICENSE.md.asc

This file was deleted.

4 changes: 0 additions & 4 deletions LICENSE.md.minisig

This file was deleted.

91 changes: 88 additions & 3 deletions Makefile
Original file line number Diff line number Diff line change
@@ -1,4 +1,89 @@
guide: clean
./make.sh
#! /bin/bash -m

# Author.: Anonymous Planet
# License.: CC BY-NC 4.0

# Setup shell
# https://github.com/QubesOS/qubes-issues/issues/8343
# if the default shell ($SHELL) is zsh, else use bash

ifneq ($(shell echo $$SHELL | grep -q 'zsh' && echo zsh), zsh)
SHELL := /bin/bash # using standard shell
else
SHELL := /bin/zsh # else use zsh (Whonix)
endif

ifneq ($(shell which safe-rm), /usr/bin/safe-rm)
RM := /usr/bin/rm # using standard rm
else
RM := /usr/share/safe-rm/bin/rm # else use safe rm
endif

# Paths

BUILD_DIR := ./export
PANDOC=/usr/bin/pandoc
PANDOC_OPTIONS=--smart --standalone

SOURCE_DOCS := $(wildcard *.md)

EXPORTED_DOCS=\
$(SOURCE_DOCS:.md=.html) \
$(SOURCE_DOCS:.md=.pdf) \
$(SOURCE_DOCS:.md=.docx) \
$(SOURCE_DOCS:.md=.rtf) \
$(SOURCE_DOCS:.md=.odt) \
$(SOURCE_DOCS:.md=.epub)

PANDOC=/usr/bin/pandoc

PANDOC_OPTIONS=--standalone --metadata title="The Hitchhiker's Guide to Online Anonymity" -t context

PANDOC_HTML_OPTIONS=--to html5
PANDOC_PDF_OPTIONS=
PANDOC_DOCX_OPTIONS=
PANDOC_RTF_OPTIONS=
PANDOC_ODT_OPTIONS=
PANDOC_EPUB_OPTIONS=--to epub3

# TODO: Makefile flags

.PHONY: clean sigs docs

# target: cleanup

clean:
./clean.sh
-$(RM) -drf $(BUILD_DIR)/*
-$(RM) -rf *sum*
-$(RM) -rf *.md.asc
-$(RM) -rf *.txt.asc
-$(RM) -rf *.md.minisig
-$(RM) -rf *.txt.minisig
-$(RM) -f $(EXPORTED_DOCS)

# target: signatures

sigs:
mkdir -p export
./make.sh

# target: documentation

docs:
%.html : %.md
$(PANDOC) $(PANDOC_OPTIONS) $(PANDOC_HTML_OPTIONS) -o $@ $<

%.pdf : %.md
$(PANDOC) $(PANDOC_OPTIONS) $(PANDOC_PDF_OPTIONS) -o $@ $<

%.docx : %.md
$(PANDOC) $(PANDOC_OPTIONS) $(PANDOC_DOCX_OPTIONS) -o $@ $<

%.rtf : %.md
$(PANDOC) $(PANDOC_OPTIONS) $(PANDOC_RTF_OPTIONS) -o $@ $<

%.odt : %.md
$(PANDOC) $(PANDOC_OPTIONS) $(PANDOC_ODT_OPTIONS) -o $@ $<

%.epub : %.md
$(PANDOC) $(PANDOC_OPTIONS) $(PANDOC_EPUB_OPTIONS) -o $@ $<
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ This guide is an open-source non-profit initiative, [licensed](LICENSE.html) und
- Raw [Markdown](https://github.com/Anon-Planet/thgtoa/raw/master/guide.md) text.

Mirrors:
- Tor Onion Mirror: <http://thgtoa27ujspeqxasrfvcf5aozqdczvgmwgorrmblh6jn4nino3spcqd.onion/>
- Tor Onion Mirror: <http://thgtoa3jzy3doku7hkna32htpghjijefscwvh4dyjgfydbbjkeiohgid.onion/>

The guide and all the files are also readily available on Archive.org and Archive.today:

Expand All @@ -40,9 +40,9 @@ Feel free to submit issues using Github Issues with the repository link above. C
Follow or contact us on:

Discussion Channels:
- Matrix room: ```#anonymity:matrix.org``` <https://matrix.to/#/#anonymity:matrix.org>
- Matrix space: ```#privacy-security-anonymity:matrix.org``` <https://matrix.to/#/#privacy-security-anonymity:matrix.org>
- Twitter at https://twitter.com/AnonyPla
- Matrix room: `#anonymity:matrix.org` <https://matrix.to/#/#anonymity:matrix.org>
- Matrix space: `#privacy-security-anonymity:matrix.org` <https://matrix.to/#/#privacy-security-anonymity:matrix.org>
- Twitter at https://twitter.com/AnonyPla
- Mastodon at https://mastodon.social/@anonymousplanet

Have a good read and feel free to share and/or recommend it!
7 changes: 0 additions & 7 deletions README.md.asc

This file was deleted.

4 changes: 0 additions & 4 deletions README.md.minisig

This file was deleted.

5 changes: 3 additions & 2 deletions _config.yml
Original file line number Diff line number Diff line change
Expand Up @@ -22,12 +22,13 @@ github:
changelog_url: CHANGELOG.html
license_url: LICENSE.html
about_url: about.html
version: v1.2.0
minisign_url: minisign.pub
links_url: links.html
twitter_url: https://anonymousplanet.org/twitter.html
twitter_url: twitter.html
mastodon_url: https://mastodon.social/@anonymousplanet
constitution_url: constitution.html
# tor_mirror_url: http://thgtoa27ujspeqxasrfvcf5aozqdczvgmwgorrmblh6jn4nino3spcqd.onion
tor_mirror_url: http://thgtoa3jzy3doku7hkna32htpghjijefscwvh4dyjgfydbbjkeiohgid.onion
defaults:
-
scope:
Expand Down
7 changes: 3 additions & 4 deletions _layouts/default.html
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,7 @@
<head>
<meta charset='utf-8'>
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<!-- Offline -->
<!-- <meta http-equiv="onion-location" content="{{ site.github.tor_mirror_url }}{{ page.url }}" /> -->
<meta http-equiv="onion-location" content="{{ site.github.tor_mirror_url }}{{ page.url }}" />
<meta http-equiv="Content-Security-Policy" content="default-src 'self' 'unsafe-inline'; base-uri 'self'; form-action 'self'; object-src 'self'; style-src 'self' 'unsafe-inline'; script-src 'self' 'unsafe-inline'">
<meta http-equiv=”X-XSS-Protection” content=”1">
<meta http-equiv="Permissions-Policy" content="interest-cohort=()"/>
Expand Down Expand Up @@ -155,7 +154,7 @@
<h1>The Hitchhiker’s Guide to Online Anonymity</h1>
</a>
<h2>How I learned to start worrying and love <del>privacy</del> anonymity</h2>
<h4 class="project-version">The latest Version is v1.1.9. See the <a href="{{ site.github.changelog_url }}" style="color:#ff4700">changelog.</a></h4>
<h4 class="project-version">The latest Version: v1.2.0. See the <a href="{{ site.github.changelog_url }}" style="color:#ff4700">changelog.</a></h4>
<section id="downloads">
{% if page.url != "/" %}
<a href="{{ site.github.home_url }}" class="btn_small">Home</a>
Expand Down Expand Up @@ -184,7 +183,7 @@ <h4 class="project-version">The latest Version is v1.1.9. See the <a href="{{ si
<a href="{{ site.github.about_url }}" class="btn_small">About</a>
{% endif %}
</section>
<h5>GPG Key Fingerprint: 9EA9 8278 639F 1CD8 53E0 96CB FF94 5075 87A6 A9B9 / Minisign public key: <a href="{{ site.github.minisign_url }}" style="color:#ff4700">minisign.pub</a></h5>
<h5>GPG Key Fingerprint: 9FA5 436D 0EE3 6098 5157 3825 17EC A05F 768D EDF6 / Minisign public key: <a href="{{ site.github.minisign_url }}" style="color:#ff4700">minisign.pub</a></h5>
<noscript><p class="jswarning">JavaScript is required to toggle light mode. JavaScript is not used for any other purpose.</p></noscript>
</div>
</header>
Expand Down
Loading

0 comments on commit 8da97cf

Please sign in to comment.