Add a link check named verify, and licence the notes CC BY 4.0 - #1
Merged
Conversation
The one failure this repo can have that looks like success: the README lists the notes, each note is a file, and a rename leaves a link that renders perfectly and 404s when clicked. Nothing on the page says so, and the person who finds out is a stranger who came for the answer. verify.py resolves every relative link in every note. External URLs are not fetched on purpose - a checker that hits the network fails on someone else's outage, and a suite that cries wolf is one people stop reading. Tested in both directions before committing: a deliberately broken link exits 1, the repo as it stands exits 0. The job is named `verify` to match the context the sibling repositories' branch rulesets require. That name is load-bearing: renaming the job turns the protection off silently, because the rule waits for a context nothing reports. The rule itself goes on after this merges, so the check exists before it is required. CC BY 4.0 rather than the Apache 2.0 the code repositories carry: the prose is the artefact here. Public with no licence meant all rights reserved, which is the opposite of the point of writing these down.
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 two gaps left when the repo was created.
verifyThe one failure this repo can have that looks like success: the README lists the notes, each note is a file, and a rename leaves a link that renders perfectly and 404s when clicked. Nothing on the page says so, and the person who finds out is a stranger who came here for an answer.
verify.pyresolves every relative link in every note. Run it locally withpython3 verify.py.External URLs are deliberately not fetched. A checker that hits the network fails on someone else's outage, and a suite that cries wolf is one people stop reading.
Tested in both directions before committing — a check that only ever passes proves nothing:
The job is named
verifyto match the context the sibling repositories' rulesets require. That name is load-bearing: renaming the job turns the protection off silently, because the rule waits for a context nothing reports. There is a comment in the workflow saying so.Licence
CC BY 4.0, canonical text from GitHub's licence API.
Apache 2.0 is what the code repositories carry, and it is written for code. The artefact here is prose, so this is a content licence. Public with no licence at all meant all rights reserved — the opposite of the point of writing these down.
Order of operations
The
required_status_checksrule is not in this PR. It goes on the ruleset after this merges, so the check exists before it is required — adding it first would block this very PR against a context nothing had yet reported.Right now
protect-maincarriesdeletion,non_fast_forwardandpull_request. After merge it will match the siblings exactly.