-
Notifications
You must be signed in to change notification settings - Fork 2.7k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Add exclude and additional option to AssembleDownstreamDocumentation #38082
Add exclude and additional option to AssembleDownstreamDocumentation #38082
Conversation
This comment has been minimized.
This comment has been minimized.
5431be1
to
d118c47
Compare
This comment has been minimized.
This comment has been minimized.
just realized when takling with @gsmet this is NOT actualy used by github bot. |
d118c47
to
ec276d4
Compare
This comment has been minimized.
This comment has been minimized.
ec276d4
to
1cb758e
Compare
This comment has been minimized.
This comment has been minimized.
Why: * downstreamdoc.yaml is used to generate the list of docs used by downstream doc builds and today its hardcoded thus very limited for downstream docs ability to adjust without changing the quarkus repo. This change addreses the need by: * adding a DOWNSTREAM_CONFIG_FILE to *optionally* override the hardcoded downstreamdoc.yaml * adding a DOWNSTREAM_ADDITONALS env var to the downstream doc build that can be used to add docs to the list of docs used by downstream doc builds * adding a DOWNSTREAM_EXCLUDES env var to the downstream doc build that can be used to exclude docs from the list of docs used by downstream doc builds + additionals
1cb758e
to
865a882
Compare
This comment has been minimized.
This comment has been minimized.
merging in as it cause no change to existing code only activates different behavior if using env variables. |
@maxandersen @aloubyansky @sheilamjones I guess this needs to be backported to 3.2, since script will be checking that branch for these changes. |
Please don't merge PRs with merge commits, they are annoying to backport. Rebase it before merging. Thanks! |
@maxandersen @gsmet @aloubyansky Created a bacporting MR here: #38212 |
Why:
downstream doc builds and today its hardcoded thus very limited
for downstream docs ability to adjust without changing the quarkus
repo.
This change addreses the need by:
hardcoded downstreamdoc.yaml
that can be used to add docs to the list of docs used by
downstream doc builds
that can be used to exclude docs from the list of docs used by
downstream doc builds + additionals
@michelle-purcell @sheilamjones FYI
Idea for this is that on downstreambuilds you can set DOWNSTREAM_EXCLUDES env to exclude files that are in dwonstream.yaml - i.e.
if do not want to main adds/excludes set speific file instead: