Make role optional in collections, capture the same information elsewhere - #225
Merged
Conversation
This was referenced Jul 10, 2026
j616
reviewed
Jul 17, 2026
samdbmg
force-pushed
the
sammg/adr/collection-roles
branch
2 times, most recently
from
July 24, 2026 09:42
0d72ad0 to
aed9815
Compare
samdbmg
force-pushed
the
sammg/adr/collection-roles
branch
from
July 30, 2026 14:51
f206104 to
a542c64
Compare
j616
approved these changes
Aug 4, 2026
Adds an ADR considering the use of the `role` property, and recommending that for most cases properties of Flows and Sources should be stored on the objects themselves
Implements the proposal in ADR0047 by making `role` in a collection optional, and adding a `priority` field for sort order. sem-ver: feature
Also adds AppNote 0020 suggesting values
Co-authored-by: James Sandford <james.sandford@bbc.co.uk>
Removes `priority` in favour of Flow collections being an ordered list
samdbmg
force-pushed
the
sammg/adr/collection-roles
branch
from
August 10, 2026 11:17
e0dc25e to
58d321c
Compare
Co-authored-by: James Sandford <james.sandford@bbc.co.uk>
Calls out that you shouldn't need a collection for capturing editorial purpose
samdbmg
force-pushed
the
sammg/adr/collection-roles
branch
from
August 10, 2026 11:18
58d321c to
56260b7
Compare
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
2 participants
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.
Details
roleshould be used for in collections, and concluding it should become optionalrolehas been used for), and corresponding appnote, tags and examplesIssue (if relevant)
GitHub Issue: Fixes #188
Also tracked as https://jira.dev.bbc.co.uk/browse/CLOUDFIT-5509
Related PRs
Replaces #173 since that PR had got rather messy!
Submitter PR Checks
Reviewer PR Checks
Info on PRs
The checks above are guidelines. They don't all have to be ticked, but they should all have been considered.