Skip to content

chore(ci): add feature flag report flag and update script#10757

Open
wmontwe wants to merge 1 commit intothunderbird:mainfrom
wmontwe:chore-add-feature-flag-report
Open

chore(ci): add feature flag report flag and update script#10757
wmontwe wants to merge 1 commit intothunderbird:mainfrom
wmontwe:chore-add-feature-flag-report

Conversation

@wmontwe
Copy link
Copy Markdown
Member

@wmontwe wmontwe commented Mar 30, 2026

Add flag to signal user-facing changes that are guarded by a feature-flag.

@github-actions
Copy link
Copy Markdown
Contributor

Missing report label. Set exactly one of: report: include, report: exclude OR report: highlight.

@github-actions github-actions bot added the tb-team Tasks and features handled by project maintainers label Mar 30, 2026
@wmontwe wmontwe added the report: exclude Exclude changes from user-facing reports (internal, minor, or not relevant to users). label Mar 30, 2026
@wmontwe wmontwe requested a review from rafaeltonholo March 31, 2026 11:09
@wmontwe wmontwe assigned rafaeltonholo and unassigned jbott-tbird Mar 31, 2026
@wmontwe wmontwe removed the request for review from jbott-tbird March 31, 2026 11:10
@rafaeltonholo
Copy link
Copy Markdown
Member

I was considering the possibility of allowing the feature flag PR label to have a broader application rather than just being a report-only flag.

Additionally, we could enforce that whenever the feature flag PR label is used, the PR body or a comment must explicitly state the name of the feature flag that the PR corresponds to.

This would enable us to maintain a report of features that are currently in progress but not yet available to users, while also providing them with a heads-up about upcoming features.

What are your feelings about this idea?

@wmontwe
Copy link
Copy Markdown
Member Author

wmontwe commented Apr 1, 2026

I think a comment with the actual feature flag name makes total sense. I would need to check if that could be extracted easily.

The dedicated flag might make sense, but then it can't be enforced. It will be an additional thing you need to do and remember to do. You would have 3 steps as a result: add the report label, add the feature label and comment the name of the feature flag. If that's not too complicated we could do that instead.

@dani-zilla What do you think?

@dani-zilla
Copy link
Copy Markdown
Contributor

Yeah, adding the feature flag label and commenting what the flag is to use it sounds reasonable. Makes it easy to see what flag it is at a glance and, when the feature is hidden by a flag that's introduced in a previous PR, you'll still be able to see what it relates to

@rafaeltonholo
Copy link
Copy Markdown
Member

We can use the following command with gh to retrieve the feature-flag from the PR description:

gh pr view "$PR_NUMBER" \
  --repo thunderbird/thunderbird-android \
  --json body \
  --jq 'try (.body | gsub("\r"; "") | capture("(?m)^feature-flag:\\s*`(?<flag>[^`]+)`$").flag) catch ""'

Tested with #10785 and got: enable_message_list_new_state

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

report: exclude Exclude changes from user-facing reports (internal, minor, or not relevant to users). tb-team Tasks and features handled by project maintainers

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants