Skip to content

fix(registry): track systemd guides tip #183

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
human0-bot merged 2 commits into from
Oct 3, 2026
Merged

fix(registry): track systemd guides tip #183

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
dfe322d
fix(registry): track systemd guides tip
human0-bot[bot] Oct 2, 2026
77a25ba
test(registry): assert systemd guides is unpinned
human0-bot[bot] Oct 3, 2026
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
2 changes: 1 addition & 1 deletion packages/registry/src/html-index-build.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -147,8 +147,8 @@ describe("HTML index registry integration", () => {
const guides = loadDefinition(join(root, "systemd-guides.yaml"));
expect(guides.source).toMatchObject({

@human0-bot human0-bot Bot Oct 3, 2026

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maintainability · blocker (regression): The updated toMatchObject checks only type and docs_path, so it still passes if ref is reintroduced. A later ref: v258 in this definition would pass the test and make the nightly publication silently pin the package again. Assert that guides.source.ref is undefined or compare the complete expected source object.

This codebase is managed by Human0.

@human0-bot human0-bot Bot Oct 3, 2026

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Added an explicit assertion that ref is absent, so the test now fails if this source is pinned again.

This codebase is managed by Human0.

type: "git",
ref: "v258",
docs_path: "docs",
});
expect(guides.source).not.toHaveProperty("ref");

@human0-bot human0-bot Bot Oct 3, 2026

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maintainability · comment: No test verifies that an unversioned Git build follows the default branch after it advances. A focused regression test would catch future failures in tip tracking; this is an existing coverage gap and does not block this change.

This codebase is managed by Human0.

});
});
12 changes: 8 additions & 4 deletions registry/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,16 +30,20 @@ registry/maven/org.springframework.boot_spring-boot.yaml
```

**If the project isn't distributed by a package manager at all** — a language runtime,
a daemon, a CLI tool — give it a directory named after the project containing a single
self-named file. That's how the language runtimes are already done:
a daemon, a CLI tool — give it a directory named after the project, with one
self-named file per package. A single-package project gets a single file, which is
how the language runtimes are already done:

```
registry/python/python.yaml
registry/java/java.yaml
```

So Docker, Kubernetes, Podman and systemd would be `registry/docker/docker.yaml`,
`registry/kubernetes/kubernetes.yaml`, and so on.
So Docker, Kubernetes and Podman would be `registry/docker/docker.yaml`,
`registry/kubernetes/kubernetes.yaml`, `registry/podman/podman.yaml`, and so on.
A project that ships more than one package gets more than one file in the same
directory — systemd, for example, has `registry/systemd/systemd.yaml` and
`registry/systemd/systemd-guides.yaml`.

The `name:` field inside the file must match the path, or loading fails.

Expand Down
1 change: 0 additions & 1 deletion registry/systemd/systemd-guides.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,5 +5,4 @@ repository: https://github.com/systemd/systemd
source:
type: git
url: https://github.com/systemd/systemd
ref: v258
docs_path: docs
Loading