Repository navigation
docs: describe this fork's CI release flow and mark prebuilt/ as legacy - #24
Merged
Merged
Conversation
AGENTS.md, the agent entrypoint, still presented upstream's prebuilt/ flow as the way to release: commit bins under prebuilt/ and run "git push allfather main". docs/CI_RELEASES.md already says that flow is retired here and GitHub Releases from CI tags are the source of truth, so an agent following AGENTS.md would do the wrong thing. - AGENTS.md: new "Releases in this fork" section (tag-driven CI releases, pre-releases, adding a board, PR-only changes to main, never push to upstream, changelog entry per PR). The prebuilt/ sections stay, marked as upstream legacy, with notes on the push target and canonical URL lines. - RELEASE_PROCEDURE.md, REPEATER_RELEASE_PROCEDURE.md, prebuilt/README.md: a legacy banner pointing at CI_RELEASES.md. - CI_RELEASES.md: releases carry .uf2 and DFU .zip for nRF52, not only .bin (the workflow uploads out/*). - docs/index.md: the docs site home links the fork docs. - changelog_ev.md: tag the #23 entry and add Docs entries for #19 and this change. New text only; upstream wording is left as is so upstream syncs stay conflict-light.
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.
What
Bring the docs in line with how this fork actually releases and with
AGENTS.md's own conventions. Docs only.AGENTS.md: a new "Releases in this fork" section ahead of the upstream release playbook. It covers:mainonly by PR onorigin, never pushed toupstream;The
prebuilt/sections stay for upstream syncs, now marked as upstream legacy, with notes on thegit push allfather mainstep and the "canonical URLs" line.docs/RELEASE_PROCEDURE.md,docs/REPEATER_RELEASE_PROCEDURE.md,prebuilt/README.md: a legacy banner pointing atdocs/CI_RELEASES.md. The first one still says "current latest version v1.15.0.1".docs/CI_RELEASES.md: releases attach.uf2and DFU.zipfor the nRF52 boards, not only.bin. The workflow uploadsout/*, so those files already ship.docs/index.md: the docs site home now links the fork docs (CAD toggle, receive filter, SNMP, manifest OTA, CI releases, changelog, supported devices).changelog_ev.md: tag the feat(build): release thirteen more nRF52 companion boards #23 entry, and add Docs entries for docs: bring README, changelog and CAD docs in line with the new boards #19 and this PR.Why
AGENTS.mdis the agent entrypoint. It told agents to commit bins intoprebuilt/and push straight toallfather main, whiledocs/CI_RELEASES.mdsays that flow is retired here and GitHub Releases from CI tags are the source of truth.Not changed, on purpose
companion_protocol.md78,AGENTS.md54,CI_RELEASES.md15,index.md2) are upstream text, identical inupstream/main.AGENTS.mdscopes the rule to new text, and rewriting upstream lines would conflict on every sync.AGENTS.mdhas issue conventions, but issues are disabled on the repo. Turning issues on fixes both; that is a repo setting, so it is left for the owner.Testing
Docs only. Checked that every relative link target exists (
CI_RELEASES.md,#releases-in-this-fork,#supported-devices), that no added line has an em or en dash, and that the release workflow uploadsout/*.Firmware or build impact
None.