Skip to content

Releases: MatrixMagician/QuadDoc

v0.1.2

Choose a tag to compare

@github-actions github-actions released this 02 Aug 11:28
v0.1.2

Changelog

Other

  • 048e6ff Point the README install example at v0.1.2
  • 7b7b6d7 Let CI own releases, and write down the procedure
  • b139add Point the README install example at v0.1.1

Install

Download the archive for your architecture, verify it, and put the binary
on your path:

VERSION=0.1.2
ARCH=$(uname -m | sed 's/x86_64/amd64/; s/aarch64/arm64/')
BASE=https://github.com/MatrixMagician/QuadDoc/releases/download/v${VERSION}

curl -fsSLO ${BASE}/quaddoc_${VERSION}_linux_${ARCH}.tar.gz
curl -fsSLO ${BASE}/checksums.txt
sha256sum --check --ignore-missing checksums.txt

tar xzf quaddoc_${VERSION}_linux_${ARCH}.tar.gz quaddoc
install -m755 quaddoc ~/.local/bin/quaddoc

The binaries are statically linked with CGO disabled, so they run on any
Linux distribution regardless of its libc. Nothing is required at runtime,
not even podman: host-context checks read files and degrade gracefully when
they are absent.

Verify the install with:

quaddoc doctor

Verifying the units it generates

QuadDoc's generated units are checked against Podman's own Quadlet
generator, not only against golden files:

QUADLET_UNIT_DIRS=units/ /usr/libexec/podman/quadlet -dryrun -user

See the rule reference
for what each check encodes and the documentation it cites.

v0.1.1

Choose a tag to compare

@MatrixMagician MatrixMagician released this 02 Aug 11:23
v0.1.1

Superseded by v0.1.2. The tool behaves identically; v0.1.1 was tagged before some test and release-pipeline fixes landed, so its pipeline shows red. Use v0.1.2.


Changelog

Correctness and validation

  • 86c5305 Skip citation verification below the supported Podman version

Other

  • 7197a72 Assert the journey's exit codes in CI instead of swallowing them
  • 09081bb Make the acceptance tests portable across hosts and Podman versions

Install

Download the archive for your architecture, verify it, and put the binary
on your path:

VERSION=0.1.1
ARCH=$(uname -m | sed 's/x86_64/amd64/; s/aarch64/arm64/')
BASE=https://github.com/MatrixMagician/QuadDoc/releases/download/v${VERSION}

curl -fsSLO ${BASE}/quaddoc_${VERSION}_linux_${ARCH}.tar.gz
curl -fsSLO ${BASE}/checksums.txt
sha256sum --check --ignore-missing checksums.txt

tar xzf quaddoc_${VERSION}_linux_${ARCH}.tar.gz quaddoc
install -m755 quaddoc ~/.local/bin/quaddoc

The binaries are statically linked with CGO disabled, so they run on any
Linux distribution regardless of its libc. Nothing is required at runtime,
not even podman: host-context checks read files and degrade gracefully when
they are absent.

Verify the install with:

quaddoc doctor

Verifying the units it generates

QuadDoc's generated units are checked against Podman's own Quadlet
generator, not only against golden files:

QUADLET_UNIT_DIRS=units/ /usr/libexec/podman/quadlet -dryrun -user

See the rule reference
for what each check encodes and the documentation it cites.

v0.1.0

Choose a tag to compare

@MatrixMagician MatrixMagician released this 02 Aug 11:08
v0.1.0

Superseded by v0.1.2. The tool behaves identically; v0.1.0 was tagged before some test and release-pipeline fixes landed, so its pipeline shows red. Use v0.1.2.


Changelog

Rules

  • 8621c64 Verify every rule citation against the manual pages, and fix four
  • 2514c7a SARIF output, generated rules reference, doctor, and QD042
  • b688989 Networking, naming, and lifecycle rules
  • 00a0e0e Rootless UID/GID rules QD010-QD013, with QD012 restated
  • 5f76633 SELinux rules QD001-QD004 on a shared source-usage map
  • 005b400 Hygiene rules QD040 and QD041, and per-key line tracking

Conversion and fixes

  • ea03b26 Fix engine, project configuration, and inline suppressions
  • 1a2c9fd Compose conversion, validated by the real Quadlet generator

Correctness and validation

  • 4f8fd2c Validate the test suite by mutation, and close the gaps it found
  • 3972273 Review SPEC.md against live Podman; record decisions

Other

  • 689eb5c Group the release changelog by area
  • b06f785 Pin the goreleaser project name to lowercase quaddoc
  • 22951af Prepare the release: install instructions and checksum verification
  • aebaf3d Release readiness: README migration, CI, and goreleaser
  • 826475c Host context: live reader, capture, and replay
  • 59f5658 Walking skeleton: lint a directory of units and report findings