Skip to content

chore: harden release packaging and CLI - #44

Merged
lloydsmart merged 1 commit into
developfrom
feature/release-packaging-and-documentation
Aug 5, 2026
Merged

lloydsmart merged 1 commit into
developfrom
feature/release-packaging-and-documentation

Conversation

@lloydsmart

Copy link
Copy Markdown
Owner

Summary

  • replace permissive inline release packaging with a strict, reproducible packaging script
  • package the correct licence, validate exact archive manifests, and publish SHA-256 checksums
  • run the complete test suite and ShellCheck before release publication
  • fix the Makefile git-cliff configuration path
  • add standard --help, --version, and -- option handling
  • make --no-file-tee suppress console-backend file mirroring and avoid dry-run temporary workspaces
  • document preservation warnings, logging behavior, dry-run side effects, CLI options, and release verification
  • add CLI, artifact-content, checksum, and repeated-build reproducibility tests

Why

The release workflow previously suppressed packaging errors, referenced the wrong licence filename, did not validate generated archives, and published no checksums. CLI and documentation behavior also diverged around option parsing, file logging, and dry-run side effects.

This change makes incomplete releases fail before publication and aligns documented behavior with the implementation.

Validation

  • make test (12 test scripts)
  • ShellCheck across production, packaging, tests, and stubs
  • actionlint across modified workflows
  • markdownlint on README.md
  • repeated packaging produces identical hashes
  • git diff --check

Closes #34

@lloydsmart
lloydsmart marked this pull request as ready for review August 5, 2026 11:02
@lloydsmart lloydsmart self-assigned this Aug 5, 2026
@lloydsmart
lloydsmart merged commit 4fdcd2e into develop Aug 5, 2026
10 checks passed
@lloydsmart
lloydsmart deleted the feature/release-packaging-and-documentation branch August 5, 2026 11:05
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

chore: fix release packaging and documentation inconsistencies

1 participant