Skip to content

Add foremanctl flavors for each existing build target #4507

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.

Sign up for GitHub

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

Jump to bottom
Closed
aneta-petrova wants to merge 6 commits into from
Closed

Add foremanctl flavors for each existing build target #4507

aneta-petrova wants to merge 6 commits into from

Conversation

@aneta-petrova
Copy link
Member

@aneta-petrova aneta-petrova commented Nov 29, 2025 •
edited by sourcery-ai bot
Loading

What changes are you introducing?

Why are you introducing these changes? (Explanation, links to references, issues, etc.)

Anything else to add? (Considerations, potential downsides, alternative solutions you have explored, etc.)

Contributor checklists

  • I am okay with my commits getting squashed when you merge this PR.
  • I am familiar with the contributing guidelines.

Please cherry-pick my commits into:

  • Foreman 3.17/Katello 4.19
  • Foreman 3.16/Katello 4.18 (Satellite 6.18)
  • Foreman 3.15/Katello 4.17
  • Foreman 3.14/Katello 4.16 (Satellite 6.17; orcharhino 7.4)
  • Foreman 3.13/Katello 4.15 (EL9 only)
  • Foreman 3.12/Katello 4.14 (Satellite 6.16; orcharhino 7.2 on EL9 only; orcharhino 7.3)
  • Foreman 3.11/Katello 4.13 (orcharhino 6.11 on EL8 only; orcharhino 7.0 on EL8+EL9; orcharhino 7.1 with Leapp)
  • Foreman 3.10/Katello 4.12
  • Foreman 3.9/Katello 4.11 (Satellite 6.15; orcharhino 6.8/6.9/6.10)
  • We do not accept PRs for Foreman older than 3.9.

Summary by Sourcery

Add containerized foremanctl documentation variants alongside existing Foreman, Katello, Satellite, and orcharhino builds and wire them into the nightly site.

New Features:

  • Generate HTML guides for new foremanctl flavors for each existing build context (Foreman EL, Foreman DEB, Katello, Satellite, and orcharhino).
  • Expose nightly documentation entry points for the new foremanctl variants in the main documentation index.
  • Provide repository-configuration snippets and related content modules specific to each new foremanctl flavor.

Enhancements:

  • Extend the default html make target and README description to include all new foremanctl build contexts in local builds.
  • Update nightly release metadata and shared documentation content to account for the new containerized deployment variants.

Build:

  • Update the deploy workflow to build and publish HTML for all new foremanctl flavors during CI deployments.

@sourcery-ai
Copy link

sourcery-ai bot commented Nov 29, 2025 •
edited
Loading

Reviewer's guide (collapsed on small PRs)

Reviewer's Guide

Adds new foremanctl-specific build flavors for each existing documentation build target and wires them into the build pipeline, site navigation, and per-flavor repository configuration snippets.

Flow diagram for Makefile targets and new foremanctl build flavors

flowchart TD
  A[make html] --> B[build-foreman-el]
  A --> C[build-foreman-deb]
  A --> D[build-katello]
  A --> E[build-foreman-el-foremanctl]
  A --> F[build-foreman-deb-foremanctl]
  A --> G[build-foreman-katello-foremanctl]

  subgraph guides build
    B --> H[guides/ make html BUILD=foreman-el]
    C --> I[guides/ make html BUILD=foreman-deb]
    D --> J[guides/ make html BUILD=katello]
    E --> K[guides/ make html BUILD=foreman-el-foremanctl]
    F --> L[guides/ make html BUILD=foreman-deb-foremanctl]
    G --> M[guides/ make html BUILD=katello-foremanctl]
  end

  subgraph repo configuration snippets
    N[snip_configuring-repositories-foreman-el-foremanctl.adoc]
    O[snip_configuring-repositories-foreman-deb-foremanctl.adoc]
    P[snip_configuring-repositories-katello-foremanctl.adoc]
    Q[snip_configuring-repositories-orcharhino-foremanctl.adoc]
    R[snip_configuring-repositories-satellite-foremanctl.adoc]
  end

  K --> N
  L --> O
  M --> P
Loading

File-Level Changes

Change Details Files
Extend CI deploy workflow to build new foremanctl documentation variants alongside existing flavors.
  • Add make html invocations for foreman-el-foremanctl, foreman-deb-foremanctl, katello-foremanctl, satellite-foremanctl, and orcharhino-foremanctl in the deploy workflow job
 .github/workflows/deploy.yml
Update top-level build orchestration to include foremanctl variants when building all HTML guides.
  • Extend the html make target to depend on new build-* targets for each foremanctl flavor so html builds all standard and foremanctl variants
  • Reuse existing build-% pattern rule so no additional per-flavor build logic is needed
 Makefile
Expose nightly foremanctl documentation entry points in the site index.
  • Add nightly links for Containerized Foreman on EL, Containerized Foreman on Debian/Ubuntu, and Containerized Foreman with Katello on EL pointing to the new foremanctl index pages
 web/content/index.adoc.erb
Document that the html meta-target now also builds foremanctl-specific guide contexts.
  • Adjust README description of the html target to mention that it builds all standard contexts plus the foremanctl builds for each context
 README.md
Introduce per-flavor repository configuration snippets for foremanctl variants to support the new build contexts.
  • Add new AsciiDoc snippet modules for configuring repositories for foreman-el-foremanctl, foreman-deb-foremanctl, katello-foremanctl, satellite-foremanctl, and orcharhino-foremanctl builds
  • Keep structure consistent with existing non-foremanctl repository configuration snippets for reuse across guides
 guides/common/modules/snip_configuring-repositories-foreman-deb-foremanctl.adoc
guides/common/modules/snip_configuring-repositories-foreman-el-foremanctl.adoc
guides/common/modules/snip_configuring-repositories-foreman-satellite-foremanctl.adoc
guides/common/modules/snip_configuring-repositories-katello-foremanctl.adoc
guides/common/modules/snip_configuring-repositories-orcharhino-foremanctl.adoc
guides/common/modules/snip_configuring-repositories-satellite-foremanctl.adoc
Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it. You can also reply to a
    review comment with @sourcery-ai issue to create an issue from it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time. You can also comment
    @sourcery-ai title on the pull request to (re-)generate the title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time exactly where you
    want it. You can also comment @sourcery-ai summary on the pull request to
    (re-)generate the summary at any time.
  • Generate reviewer's guide: Comment @sourcery-ai guide on the pull
    request to (re-)generate the reviewer's guide at any time.
  • Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
    pull request to resolve all Sourcery comments. Useful if you've already
    addressed all the comments and don't want to see them anymore.
  • Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
    request to dismiss all existing Sourcery reviews. Especially useful if you
    want to start fresh with a new review - don't forget to comment
    @sourcery-ai review to trigger a new review!

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

@github-actions github-actions bot added Needs tech review Requires a review from the technical perspective Needs style review Requires a review from docs style/grammar perspective Needs testing Requires functional testing labels Nov 29, 2025
@github-actions
Copy link

github-actions bot commented Nov 29, 2025 •
edited
Loading

The PR preview for 91cbf6f is available at theforeman-foreman-documentation-preview-pr-4507.surge.sh

The following output files are affected by this PR:

show diff

show diff as HTML

@aneta-petrova aneta-petrova mentioned this pull request Nov 29, 2025
Merged
11 tasks
@aneta-petrova aneta-petrova removed Needs tech review Requires a review from the technical perspective Needs style review Requires a review from docs style/grammar perspective Needs testing Requires functional testing labels Nov 29, 2025
@aneta-petrova
Add initial content for foremanctl-powered install
67e4946 
Include existing server pre-installation assemblies

Add initial structure for foremanctl-powered installation guide
@aneta-petrova
cm
91cbf6f
@aneta-petrova
Copy link
Member Author

aneta-petrova commented Dec 5, 2025

Closing in favor of #4506

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

Reviewers

No reviews

Assignees

No one assigned

Labels

Not yet reviewed

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

1 participant

@aneta-petrova