-
Notifications
You must be signed in to change notification settings - Fork 29.8k
Closed
Copy link
Labels
P2Important issues not at the top of the work listImportant issues not at the top of the work listc: tech-debtTechnical debt, code quality, testing, etc.Technical debt, code quality, testing, etc.infra: recipesIssues with flutter/recipesIssues with flutter/recipesteam-infraOwned by Infrastructure teamOwned by Infrastructure teamtriaged-infraTriaged by Infrastructure teamTriaged by Infrastructure team
Milestone
Description
The recipes/flutter/docs.py recipe is both extremely confusing, and under-documented.
It does, based on both properties provided, and by sniffing the branch, the following:
- [Always]
PrepareDocs- Runs
dev/bots/docs.sh - ... which in turn runs
dev/tools/create_api_docs.dart - ... which, conditionally on
LUCI_BRANCH=stable1, changes the output slightly - ... which, conditionally on
LUCI_CI=<set>, generates offline assets. I'm not sure when this is set.
- Runs
- [Sometimes] Uploads the result of
PrepareDocsto GS- ... based on
validation: docsintarget.properties - ... and if the branch is
masterorstable, deploys the docs to Firebase
- ... based on
These recipes are run from the Linux docs_* targets in //.ci.yaml:
Lines 611 to 614 in b98b1e3
| validation: docs | |
| validation_name: Docs | |
| firebase_project: main-docs-flutter-prod | |
| release_ref: refs/heads/master |
In my mind, it would be good to:
- Consolidate
.ci.yamltarget properties under adocssub-property - Make the various optional tasks explicit instead of implied based on the current branch
- Upgrade all active branches (
master, current-beta-candidate, current-stable-candidate)
A possible end result (this is very hand-wavey, and could use a longer discussion):
# .ci.yaml
targets:
- name: Linux docs_master
recipe: flutter/docs
enabled_branches:
- master
properties:
docs:
generate: true|include-offline-docs
post_process: false
upload_to_firestore: <project-name>/cc @jtmcdole Could be a candidate for a "my first recipes" type project for a new hire or returning SWE
Footnotes
-
Which, confusingly, is also set, on any release candidate branch, even though it's not
stable↩
Metadata
Metadata
Assignees
Labels
P2Important issues not at the top of the work listImportant issues not at the top of the work listc: tech-debtTechnical debt, code quality, testing, etc.Technical debt, code quality, testing, etc.infra: recipesIssues with flutter/recipesIssues with flutter/recipesteam-infraOwned by Infrastructure teamOwned by Infrastructure teamtriaged-infraTriaged by Infrastructure teamTriaged by Infrastructure team