Skip to content
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

Merged
merged 2 commits into from
Jan 15, 2024

Conversation

maxandersen
Copy link
Contributor

@maxandersen maxandersen commented Jan 8, 2024

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

@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.

export DOWNSTREAM_ADDITIONALS=src/main/asciidoc/cli-tooling.adoc 
export DOWNSTREAM_EXCLUDES=security-jpa,security-cors 
mvn package

if do not want to main adds/excludes set speific file instead:

export DOWNSTREAM_CONFIG_FILE=redhatprod.yaml
mvn package

@quarkus-bot

This comment has been minimized.

@maxandersen maxandersen changed the title Add exclude option to AssembleDownstreamDocumentation Add exclude and additional option to AssembleDownstreamDocumentation Jan 8, 2024
@quarkus-bot

This comment has been minimized.

@maxandersen
Copy link
Contributor Author

just realized when takling with @gsmet this is NOT actualy used by github bot.

@quarkus-bot

This comment has been minimized.

@quarkus-bot

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
@quarkus-bot

This comment has been minimized.

@sheilamjones sheilamjones requested review from sheilamjones and gsmet and removed request for sheilamjones January 11, 2024 11:56
@maxandersen maxandersen merged commit e3dd81b into quarkusio:main Jan 15, 2024
3 of 5 checks passed
@quarkus-bot quarkus-bot bot added this to the 3.7 - main milestone Jan 15, 2024
@maxandersen
Copy link
Contributor Author

merging in as it cause no change to existing code only activates different behavior if using env variables.

@MichalMaler
Copy link
Contributor

@maxandersen @aloubyansky @sheilamjones I guess this needs to be backported to 3.2, since script will be checking that branch for these changes.

@gsmet
Copy link
Member

gsmet commented Jan 15, 2024

Please don't merge PRs with merge commits, they are annoying to backport. Rebase it before merging. Thanks!

@gsmet gsmet modified the milestones: 3.7 - main, 3.6.6 Jan 15, 2024
@MichalMaler
Copy link
Contributor

@maxandersen @gsmet @aloubyansky Created a bacporting MR here: #38212

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

Successfully merging this pull request may close these issues.

None yet

4 participants