mirror of
https://github.com/Anon-Planet/thgtoa.git
synced 2026-05-06 11:34:18 +02:00
Fix copy information in website footer
And also move the develop workflow information to docs/code to cleanup the guide documents, preventing accidental addition to the PDF. Signed-off-by: nopeitsnothing <no@anonymousplanet.org>
This commit is contained in:
@@ -97,7 +97,7 @@ jobs:
|
|||||||
- name: 📤 Upload export directory as artifact
|
- name: 📤 Upload export directory as artifact
|
||||||
uses: actions/upload-artifact@v4
|
uses: actions/upload-artifact@v4
|
||||||
with:
|
with:
|
||||||
name: export
|
name: upload pdf artifact
|
||||||
path: |
|
path: |
|
||||||
export/*
|
export/*
|
||||||
if-no-files-found: error
|
if-no-files-found: error
|
||||||
|
|||||||
@@ -1,50 +0,0 @@
|
|||||||
# Development
|
|
||||||
|
|
||||||
??? Note "How the pipeline works"
|
|
||||||
|
|
||||||
**Automatic PDF Generation:** - Builds both light and dark mode PDFs from MkDocs source
|
|
||||||
**SHA256 Hash Generation:** - Creates hash files for integrity verification
|
|
||||||
**GPG Signature Signing:** - Signs all PDFs and hash files with repository GPG key
|
|
||||||
**VirusTotal Scanning:** - Automatically scans PDFs and updates release notes
|
|
||||||
**Release Automation:** - Packages everything into GitHub releases
|
|
||||||
|
|
||||||
## Architecture
|
|
||||||
|
|
||||||
### Build PDF Workflow (`build-sign-release.yml`)
|
|
||||||
|
|
||||||
!!! Note "Steps"
|
|
||||||
|
|
||||||
- Checkout repository
|
|
||||||
- Set up Python and MkDocs Material
|
|
||||||
- Install Chromium browser
|
|
||||||
- Generate both light and dark mode PDFs with `scripts\build_guide_pdf.py`
|
|
||||||
- Create SHA256 and blake2 hash files in `export/`
|
|
||||||
- Sign all files with GPG in `export/`
|
|
||||||
- Upload artifacts to GitHub Actions **manually**
|
|
||||||
|
|
||||||
### SHA256 Hash Verification
|
|
||||||
|
|
||||||
!!! Note "**How it works**"
|
|
||||||
|
|
||||||
- Each PDF gets a unique SHA256 hash calculated at build time
|
|
||||||
- Hash stored in `.sha256` files alongside the PDFs
|
|
||||||
- Combined `sha256sum.txt` for batch verification
|
|
||||||
|
|
||||||
### GPG Signature Verification
|
|
||||||
|
|
||||||
**Purpose:** Verify authenticity and prevent tampering
|
|
||||||
|
|
||||||
!!! Note "How it works"
|
|
||||||
|
|
||||||
- Detached signatures created for each PDF and hash file
|
|
||||||
- Public keys available in `/pgp/` directory
|
|
||||||
|
|
||||||
**Verification command:**
|
|
||||||
```bash
|
|
||||||
gpg --import pgp/anonymousplanet-master.asc
|
|
||||||
gpg --verify export/thgtoa.pdf.sig export/thgtoa.pdf
|
|
||||||
```
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
*This workflow is designed for security-conscious users who need to verify the authenticity and integrity of downloaded documents.*
|
|
||||||
+4
-3
@@ -130,8 +130,9 @@ nav:
|
|||||||
- Verify: verify/index.md
|
- Verify: verify/index.md
|
||||||
- Guide:
|
- Guide:
|
||||||
- guide/index.md
|
- guide/index.md
|
||||||
- Workflow Documentation: guide/dev-workflow.md
|
- Code:
|
||||||
- Code: code/index.md
|
- code/index.md
|
||||||
|
- Develop: code/develop.md
|
||||||
- Contribute: contribute/index.md
|
- Contribute: contribute/index.md
|
||||||
- Constitution: constitution/index.md
|
- Constitution: constitution/index.md
|
||||||
- Mirrors: mirrors/index.md
|
- Mirrors: mirrors/index.md
|
||||||
@@ -139,4 +140,4 @@ nav:
|
|||||||
- Releases: changelog/index.md
|
- Releases: changelog/index.md
|
||||||
|
|
||||||
copyright: |
|
copyright: |
|
||||||
© 2023-2026 <a href="https://anonymousplanet.org/" target="_blank" rel="noopener">Anonymous Planet</a>
|
<a href="https://anonymousplanet.org/">The Hitchhiker's Guide</a> ©2023-2026 by <a href="https://psa.anonymousplanet.org/">Anonymous Planet</a> is licensed under <a href="https://creativecommons.org/licenses/by-nc/4.0/">CC BY-NC 4.0</a><img src="https://mirrors.creativecommons.org/presskit/icons/cc.svg" alt="" style="max-width: 1em;max-height:1em;margin-left: .2em;"><img src="https://mirrors.creativecommons.org/presskit/icons/by.svg" alt="" style="max-width: 1em;max-height:1em;margin-left: .2em;"><img src="https://mirrors.creativecommons.org/presskit/icons/nc.svg" alt="" style="max-width: 1em;max-height:1em;margin-left: .2em;"></a>
|
||||||
|
|||||||
Reference in New Issue
Block a user