Skip to content

docs: drop the em dashes and diagram how a reusable change propagates #99

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Jaro-c merged 1 commit into from
Jul 20, 2026
Merged

docs: drop the em dashes and diagram how a reusable change propagates #99

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 18 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,12 +21,28 @@ jobs:
- **Release contracts:** `installer-contract`
- **Policy gates:** `dco`, `main-guard`, `line-limit`

Pin to a release **commit SHA** with the version in a comment — Dependabot bumps
Pin to a release **commit SHA** with the version in a comment. Dependabot bumps
it when a newer release ships. Allowed action sources: `actions/*`, `Glyndor/*`,
and `oven-sh/setup-bun` (needed by `bun-ci`).

## How a change reaches a repository

```mermaid
flowchart LR
E["Edit a reusable here"] --> M["Merge to main"]
M --> P["Prove it on one consumer<br/>pinned at the merge SHA"]
P -->|green| T["Tag vX.Y.Z"]
T --> D["Dependabot opens a bump<br/>in each consumer"]
D --> C["Consumer CI passes<br/>then the pin moves"]
P -.->|red| E
```

The SHA pin is the buffer: a change here never reaches a repository until that
repository's own CI has passed on it. Tag only after a real consumer is green,
because a tag is immutable and reaches the whole organisation at once.

## Versioning

Releases are semver tags on `main` — **major** for a breaking change to a
Releases are semver tags on `main`: **major** for a breaking change to a
reusable's inputs or behavior, **minor** for additive changes, **patch** for
fixes.
8 changes: 4 additions & 4 deletions profile/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,16 +16,16 @@ Website: glyndor.net
| [podup](https://github.com/Glyndor/podup) | Rust | docker-compose translator and runner for rootless Podman |
| [epistle](https://github.com/Glyndor/epistle) | Rust | Self-hosted, headless mail server (SMTP/IMAP/JMAP) |
| [epistle-panel](https://github.com/Glyndor/epistle-panel) | TypeScript | Web admin panel for epistle |
| [authcore](https://github.com/Glyndor/authcore) | Go | Auth primitives library — passwords, tokens, OAuth2/OIDC |
| [authcore](https://github.com/Glyndor/authcore) | Go | Auth primitives library: passwords, tokens, OAuth2/OIDC |
| [unitpm](https://github.com/Glyndor/unitpm) | Go | systemd-native process manager |
| [klyradb](https://github.com/Glyndor/klyradb) | Rust | Local database instance manager (desktop app) |
| [specio](https://github.com/Glyndor/specio) | TypeScript | Browser extension: on-device website tech-stack detection |
| [viden](https://github.com/Glyndor/viden) | TypeScript | Browser extension: video stream downloader |

## Contributing

Issues are open to everyone. Pull requests are invitation-only — this code
touches kernel-level surfaces (SSH, firewall, ports). Report vulnerabilities
privately via [`SECURITY.md`](https://github.com/Glyndor/.github/blob/main/SECURITY.md);
Issues are open to everyone. Pull requests are invitation-only, because this
code touches kernel-level surfaces (SSH, firewall, ports). Report
vulnerabilities privately via [`SECURITY.md`](https://github.com/Glyndor/.github/blob/main/SECURITY.md);
contribution flow and conventions are in
[`CONTRIBUTING.md`](https://github.com/Glyndor/.github/blob/main/CONTRIBUTING.md).
Loading