Repository navigation
docs: add a security policy and bring the design pages in line with the programs that use the kit - #26
Merged
Conversation
…he programs that use the kit - SECURITY.md: private reporting, scope (the shared signing workflow, the release templates, colony_ui::paths, the colony.json schema) and the supported versions (latest colony-ui, main and the organisation pin). - README Status: Colony and Spotter use the 0.1.6 preferences kit. - filesystem.md: Digger (repository D1Gg2r) and Spotter conform; the non-conformance table is empty. - navigation.md, settings-page.md: Digger's files are under src/ui/ in D1Gg2r; add Spotter to the comparison tables; Colony no longer has a sidebar slide, and its tutorial text changed. - repository-layout.md: Colony's file sizes, then and now. - releases.md: a 0.x library sets bump-minor-pre-major: true.
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
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.
Closes the remaining documentation gaps from the conformance audit (DOC-1, DOC-5, DOC-10, REL-2). Docs only: no code, no generated file and no workflow changes.
What changed
SECURITY.md(new). Private vulnerability reporting (already enabled on this repository), what is in scope (the sharedsign-and-publish.ymlworkflow and its key handling and SignPath gate, the release templates,colony_ui::pathsname validation, thecolony.jsonschema), what is out of scope, and the supported versions: the latestcolony-uion crates.io, andmainplus the organisation pin for the signing workflow.colony-ui0.1.6. The other claims (paths tests on 3 OSes, 0.1.7 waiting on the Trusted Publisher, SignPath wired but unused) are unchanged.design/filesystem.md. The Digger row is gone: Digger (repositoryD1Gg2r) resolves its data and config throughcolony_ui::paths::locateand copies its old<data>/digger/history.dbacross once. Spotter is listed as conforming too.design/navigation.md,design/settings-page.md. Digger's files are cited fromD1Gg2r(src/ui/mod.rs,src/ui/settings/) instead of asrc/ui.rsthat cannot exist. Both comparison tables are re-checked against currentmainand gain a Spotter column. Digger's identity button is nowsz(15)with[4, 8]padding. Colony no longer has a 200 ms sidebar slide (App::SIDEBAR_ANIM_MSis gone), and its tutorial text now names the Colony title, not a gear icon. The "Colony's fixed 160" category list is described in the past tense, because Colony now uses the kit's list.design/repository-layout.md. The "largest files in Colony today" table now shows then and now:theme.rswent from 100 KB to 4 KB,settings.rsfrom 64 KB to 18.6 KB, anddownload.rsbecamesrc/download/(six files). The largest file today issrc/persistence.rsat 62 KB.design/releases.md. "Libraries published to crates.io" now lists a third difference from the template: a 0.x library setsbump-minor-pre-major: true, so a breaking change bumps 0.1.x to 0.2.0, not 1.0.0. This matchesrelease-please-config.jsonandcrates/colony-ui/CHANGELOG.md.REL-1: the
action_requiredCI run on release PR #18 was approved, so its required checks can run. #18 stays unmerged until the crates.io Trusted Publisher is registered.How it was verified
main: Colony d2e8927, Spotter 5835c2d, D1Gg2r f73cfa4, Grape 08b670d. File sizes come from the git tree API, and the identity button, categories and paths calls come from the source.SECURITY.mdscope was checked againstsign-and-publish.yml(the key is written to a temp file and removed on exit, signatures are verified after signing, and SignPath refuses to run without its token), againstcrates/colony-ui/src/paths.rs(.., separators, trailing dot or space, reservedapps), and against the organisation pin intemplates/sign-and-publish-caller.yml.cargo run -p colony-tokens -- checkis unaffected.