Repository navigation
Point AGENTS.md at the one list of environment variable names - #109
Merged
Merged
Conversation
AGENTS.md gains a section linking common-ci's list of environment variable names (environment-variables.md, made from environment-variables.json) at commit 18f9a570, and saying the list decides. Documentation only.
The list at that commit holds the names review found missing.
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.
The problem
James Rosewell decided at about 17:20 UTC on 12 November, "We should add to common-ci the env vars that are being used across the languages and reference this from other places. This ensure consistency."
common-ci#319 adds that list.
environment-variables.jsonholds every environment variable name that the packages, tests, examples and CI scripts of every language read, with what each holds, the languages that read it and the deprecated names each replaced, andenvironment-variables.mdis the page made from it. This draft points this repository at the list and says the list decides.What changed
Documentation only, at head 55b6ab5e.
AGENTS.mdgains a section, "Environment variable names", before "Products keep their own CI scripts". It links the page and the JSON file in common-ci at commit d8a9c596, the reviewed head of common-ci#320, which adds the names review found missing from the list common-ci#319 made. The section says the list decides, and asks for the list in common-ci to change in the same piece of work as any new name or any old name read again. It also says that this repository's own name check,ci/check-environment-variable-names.ps1, still keeps a list of its own, and that where the two differ the list in common-ci is the one to follow.AGENTS.mdonrchas the "Releases" section twice, word for word, since #29 and #34 each added one. The second copy is removed.The links are to a fixed commit so that they say the same thing whatever happens to the branch later. common-ci#319 and #320 are on common-ci's
rcand not yet on itsmain, which is why the links name the commit rather thanmain.The head is the earlier head 9b7f1d3 with
rcat df0949d7 merged in, and then the removal of the second "Releases" section.Checks
Pull request checks on the head, all finished and passed.
James Rosewell decided at about 11:35 UTC on 12 November, for a draft that changes only CI scripts and their notes, "rebuild and include, but the change doesn't impact the code so no need to run the full builds." This draft changes no package code, test, example or CI script, only
AGENTS.md, so no full build was started. No package's folder changes, so the release plan releases nothing for it.What remains
ci/check-environment-variable-names.ps1read the list in common-ci instead of keeping its own. It is left as it is in this round, so nothing changes for the check during a week of releases.main, the links can move to a commit onmain.