Add the repository furniture the other marstack projects carry - #4
Merged
Conversation
marstack-cloud, -secrets and -access each ship a changelog, contributing guide, security policy, code of conduct, owners file, Makefile and release workflow. This repository had none of them, which made a project with 128 integration assertions and a published usage guide read as half-finished. CODE_OF_CONDUCT.md and CODEOWNERS are copied verbatim, since they are organisation policy rather than repository content and should not drift. The rest is adapted rather than translated, because the Go pattern does not carry over: - The Makefile drives cargo, and adds integration, validation and bench targets for the three suites that need root. There is no `site` target: the other repos generate meridian.css from internal/console/assets, and a CLI with no console has to vendor it. - release.yml builds on a matrix of ubuntu-24.04 and ubuntu-24.04-arm rather than cross-compiling. mars links libseccomp, so a cross build would mean cross-linking a C library for no reason when arm64 runners are free for public repositories. A guard job still refuses a tag that is not on main, and the notes still come from the changelog section named after the tag. - CHANGELOG.md puts everything under Unreleased, because nothing is tagged yet. It records the three bugs found this week alongside the features. - SECURITY.md states plainly that there are no supported versions and that this is not production software, then says where the privilege actually is and what is not covered — rootless, SELinux and AppArmor labels, CNI, and the limits of the attack surface figures. Verified in the dev VM: all three workflows parse, `make check` runs fmt, clippy and 106 unit tests, `make dist` produces an archive and SHA256SUMS, and every relative link in the new files resolves.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
marstack-cloud,-secretsand-accesseach ship a changelog, contributing guide, security policy, code of conduct, owners file, Makefile and release workflow. This repository had none, which made a project with 128 integration assertions and a published usage guide read as half-finished.CODE_OF_CONDUCT.mdandCODEOWNERSare copied verbatim — organisation policy, not repository content, and should not drift.The rest is adapted, because the Go pattern does not carry over:
Makefileintegration,validation,benchfor the suites needing root. Nositetarget — the other repos generatemeridian.cssfrominternal/console/assets, and a CLI with no console has to vendor itrelease.ymlubuntu-24.04andubuntu-24.04-arminstead of cross-compiling, since mars links libseccomp and arm64 runners are free for public repos. Guard job still refuses a tag not onmain; notes still come from the changelog section named after the tagCHANGELOG.mdUnreleased, because nothing is tagged. Records the three bugs found this week next to the featuresSECURITY.mdVerified in the dev VM: all three workflows parse,
make checkruns fmt + clippy + 106 unit tests,make distproduces an archive andSHA256SUMS, every relative link resolves, andubuntu-24.04-armis confirmed generally available and free for public repositories.