Skip to content

Cleanup and make explicit the flutter/docs recipe and related tools #169108

@matanlurey

Description

@matanlurey

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:

These recipes are run from the Linux docs_* targets in //.ci.yaml:

flutter/.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.yaml target properties under a docs sub-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

  1. 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 listc: tech-debtTechnical debt, code quality, testing, etc.infra: recipesIssues with flutter/recipesteam-infraOwned by Infrastructure teamtriaged-infraTriaged by Infrastructure team

Projects

No projects

Relationships

None yet

Development

No branches or pull requests

Issue actions