Skip to content

docs: ADR-0017 and the repository's settings since it opened - #61

Merged
Madraka merged 3 commits into
mainfrom
docs/repository-opens
Nov 18, 2026
Merged

Madraka merged 3 commits into
mainfrom
docs/repository-opens

Conversation

@Madraka

@Madraka Madraka commented Nov 18, 2026

Copy link
Copy Markdown
Contributor

What and why

The repository opened on 2026-11-18, and the documents still described a private one.

  • ADR-0017, accepted by the project lead on 2026-11-18. The repository is public before the trademark review of the name (Review the name "Podbay" for trademark use before the repository is public #4). The review is done before version 0.1, and the project is renamed by a new decision if it fails. It amends ADR-0001 (decision 8) and ADR-0003's third consequence. Neither file is edited, since an accepted record is never changed. The ADR index says what it amends.

  • docs/repository.md, sections 1 to 4, say what GitHub holds now. Every setting was read through the API today:

    • visibility, the two rulesets, secret scanning with push protection, private vulnerability reporting;
    • code scanning: default setup, extended suite;
    • fork approval for every outside contributor;
    • auto-merge, immutable releases, Discussions, and the environment release (the lead's review, tags v*);
    • no self-hosted runner, 90 days of retention.

    The page also records:

    • what GitHub did not give: non-provider patterns and validity checks;
    • how the repository opened, including the rulesets refused for some seconds after the visibility change;
    • what is open: the organisation does not require two-factor sign-in.
  • .github/rulesets/main.json is identical to ruleset 27536582, as compared by a script. That includes the code scanning rule and three defaults GitHub adds to the pull request rule.

  • docs/status.md moves the repository's protections from section 2 (not yet) to section 1. The README link and the issue chooser follow: the chooser gets a link to Discussions for questions.

Refs #5. The one condition of #5 that is not met is the name review, and ADR-0017 makes it a condition of version 0.1 instead. Closing #5 is left to the lead.

Not verified

  • That SECURITY.md's report link opens the form for someone signed out (step 6 of the old plan). I could not check that from here.
  • The ruleset refusal right after the visibility change is recorded as the lead's session reported it. It was not seen from this session.

Checklist

  • pnpm check is green (documents and settings only; pnpm test:workerd not run, nothing it covers changed).
  • Original work. Nothing here comes from another mail product: no code, schema, test, text, translation or asset. No dependency under AGPL or GPL.
  • It touches no trust boundary in code. The settings record is B10: the ruleset file is a record and changes nothing on GitHub.
  • It relies on no Cloudflare fact.
  • Commits are conventional and signed off (git commit -s).

🤖 Generated with Claude Code

Madraka and others added 2 commits November 18, 2026 14:20
Decided by the project lead on 2026-11-18. The repository is public
from that day, before the trademark review of the name (issue #4). The
review is done before version 0.1 is released, and if it fails the
project is renamed by a new decision before any release. It amends
ADR-0001, decision 8, and the third consequence of ADR-0003; neither
file is changed.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Signed-off-by: Madraka <8898640+Madraka@users.noreply.github.com>
docs/repository.md says what GitHub holds today, each setting read
through the API on 2026-11-18:
- the repository is public;
- the two rulesets are active, and `main` also has a code scanning gate;
- secret scanning with push protection, private vulnerability
  reporting and code scanning (extended suite) are on;
- outside contributors' fork workflows wait for approval;
- auto-merge, immutable releases and Discussions are on;
- the environment `release` waits for the lead and for tags `v*`;
- no self-hosted runner, and 90 days of retention.

It also records what GitHub did not give (non-provider patterns and
validity checks), how the repository opened, and what is open: the
organisation does not require two-factor sign-in, the name review,
and that nothing compares the ruleset files with GitHub.

.github/rulesets/main.json is now identical to ruleset 27536582,
code scanning rule and the three defaults GitHub adds included. The
issue forms get a link to Discussions for questions. docs/status.md
moves the repository's protections from section 2 to section 1.

Refs #5

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Signed-off-by: Madraka <8898640+Madraka@users.noreply.github.com>
@Madraka

Madraka commented Nov 18, 2026

Copy link
Copy Markdown
Contributor Author

audit: one sentence to correct, then pass

Read: every changed line. The ruleset file was compared with what GitHub holds for ruleset 27536582 (name, target, enforcement, conditions, bypass, rules): identical. Each setting in section 2 of docs/repository.md matches what I set and read back through the API today.

To correct before this merges, because an accepted record cannot be changed afterwards:

  • ADR-0017, Context: "GitHub refused each of them … the rulesets for main and for release tags, secret scanning with push protection, private vulnerability reporting and code scanning." Code scanning was never asked for while the repository was private, so it was not refused. The mistake is in the page this sentence was taken from (section 3 of docs/repository.md as I wrote it), not in your reading. What GitHub refused on 2026-11-18, each with an answer I saw: the rulesets and classic branch protection ("Upgrade to GitHub Pro or make this repository public"), secret scanning ("not available for this repository"), private vulnerability reporting (not found), and the approval for workflows from forks ("not allowed for private repositories"). Say those four, and that code scanning was left for the day it opened.

Found to hold:

  • ADR-0017 says what the lead decided, amends without editing ADR-0001 and ADR-0003, and makes the name review a condition of version 0.1.
  • The status document moves the repository's protections from "not yet" to "enforced", and says plainly that no check compares the record with GitHub yet.
  • Section 4 names what is still open: two-factor sign-in for the organisation, the name review, the record compared by hand.

Not blocking: the milestone "Before the repository is public" keeps its name though the day has passed; #5 and #6 are still in it. I will rename it when #5 closes.

…ode scanning was not asked for

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Signed-off-by: Madraka <8898640+Madraka@users.noreply.github.com>
@Madraka

Madraka commented Nov 18, 2026

Copy link
Copy Markdown
Contributor Author

Corrected in b8fab73: the Context of ADR-0017 now names the four protections GitHub refused on 2026-11-18, each with its answer, and says code scanning was not asked for while the repository was private. No other line changed. Ready for audit once CI is green.

@Madraka

Madraka commented Nov 18, 2026

Copy link
Copy Markdown
Contributor Author

audit: pass

Read at b8fab73. The one sentence I asked for is corrected: the Context of ADR-0017 now names the four protections GitHub refused while the repository was private, each with the answer it gave, and says that code scanning was not asked for and was left for the day the repository opened. That matches what happened.

The commit changes that one line and nothing else. Everything read before still holds: .github/rulesets/main.json equals ruleset 27536582 as GitHub has it, and sections 1 to 4 of docs/repository.md match the settings in force.

The required checks are still running on this head. Merge when they are green; the ruleset holds the merge until then.

@Madraka
Madraka merged commit 2df58da into main Nov 18, 2026
6 checks passed
@Madraka
Madraka deleted the docs/repository-opens branch November 18, 2026 13:27
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.

1 participant