chore: use journeys as prs qa contract - #1250
Draft
ovitrif wants to merge 3 commits into
Draft
Conversation
1 task
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 #1249
Counterpart: synonymdev/bitkit-ios#743
This PR:
scripts/journeys_index.pyand the generatedjourneys/index.json, which lists per journey the identifiers its actions name, the source files that declare them, and the screens its actions name.--checkand fails on a stale index or on an identifier that no source file declares.#### Journeysin the PR template and the/prcommand, and limits#### Manual Teststo what a journey cannot express.AGENTS.md: a PR that changes user-visible behaviour adds or updates the journeys that prove it, and updates any journey whose route it changes.Description
The
/prcommand now regenerates the index, lists the journeys the branch adds or updates, and stops when a user-visible change has no journey or when a journey whosesourcesthe branch changes no longer matches the diff.A source file declares an identifier when it contains it as a string literal, or as a string template whose text before the first interpolation begins the identifier while the rest has no capital letters (
"N$text"declaresN9but notNRemove). The script uses only the Python standard library and runs on Python 3.9 and later.Open PRs that add or change journeys (#1231, #1225, #1217, #1170) regenerate the index after this merges. Every identifier on their current heads resolves.
Design
N/A — no UI changes.
Preview
N/A — no user-visible changes.
QA Notes
Journeys
N/A — no user-visible behaviour change.
Manual Tests
/pr --dry: the saved description lists that journey under#### Journeys— agent tooling, not an app flow.Automated Checks
python3 scripts/journeys_index.py --checkpasses on Python 3.9 and 3.12: 34 journeys, 91 identifiers, all declared.actionlintpasses onjourneys.yml.Check journeys indexpassed on this PR's head.Check journeys indexonmasterpushes (after merge).