Skip to content

Conversation

@maximiliankolb
Copy link
Contributor

@maximiliankolb maximiliankolb commented Dec 15, 2025

What changes are you introducing?

Add two modules to upload Deb packages to Deb repositories.

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

We have prodedures to RPM packages but not Deb packages.

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

Tested on Foreman 3.16+Katello 4.18.

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)
  • We do not accept PRs for Foreman older than 3.12.

Summary by Sourcery

Document uploading content to Deb repositories via both CLI and web UI.

Documentation:

  • Add procedures for uploading content to Deb repositories using the CLI.
  • Add procedures for uploading content to Deb repositories using the web UI.
  • Integrate Deb upload procedures into the common content importing guide.

@maximiliankolb maximiliankolb added this to the Managing content milestone Dec 15, 2025
@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 Dec 15, 2025
@sourcery-ai
Copy link

sourcery-ai bot commented Dec 15, 2025

Reviewer's guide (collapsed on small PRs)

Reviewer's Guide

Adds documentation modules describing how to upload Debian package content to Deb repositories via both the CLI and the web UI, and integrates them into the shared importing content guide.

File-Level Changes

Change Details Files
Integrate Deb upload procedures into the shared importing content documentation.
  • Update the common importing content assembly to reference Deb-specific upload procedures and ensure they appear in the overall content workflow documentation.
guides/common/assembly_importing-content.adoc
Document procedure for uploading Deb packages to Deb repositories using the CLI.
  • Create a new module describing prerequisites, commands, and steps to upload Deb package content to Deb repositories via the command-line interface.
  • Align structure, headings, and admonitions with existing RPM upload CLI documentation for consistency.
guides/common/modules/proc_uploading-content-to-deb-repositories-by-using-cli.adoc
Document procedure for uploading Deb packages to Deb repositories using the web UI.
  • Create a new module that outlines how to upload Deb packages to Deb repositories through the Foreman/Katello web interface.
  • Mirror layout and terminology used in existing RPM upload web UI documentation to keep user experience consistent.
guides/common/modules/proc_uploading-content-to-deb-repositories-by-using-web-ui.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

Copy link

@sourcery-ai sourcery-ai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hey there - I've reviewed your changes and they look great!


Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

@github-actions
Copy link

The PR preview for 3363cd1 is available at theforeman-foreman-documentation-preview-pr-4531.surge.sh

The following output files are affected by this PR:

show diff

show diff as HTML

@maximiliankolb maximiliankolb added testing done No issues from the functional perspective and removed Needs testing Requires functional testing labels Dec 15, 2025
@maximiliankolb
Copy link
Contributor Author

@quba42 Can you please review my PR?

= Uploading content to Deb repositories by using Hammer CLI

[role="_abstract"]
You can upload individual Deb packages to Deb repositories by using Hammer CLI.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Optional (because we're not there with the other abstracts yet and it wouldn't be fair to require this at the moment): Ideally, an abstract should also clarify the use case: when and why a user might want to follow the procedure, not just what the procedure does.

For example when: Is the "individual packages" part important here? Is this what distinguishes this procedure from other procedures in the guide? When would a user want to upload an individual package?

Or why: What will happen when the package will be uploaded? Can we explicitly specify that the package will then be available for hosts?

@maximiliankolb
Copy link
Contributor Author

@quba42 Can you please review my PR?

@quba42
Copy link
Contributor

quba42 commented Jan 8, 2026

We have a pretty strong "best practice recommendation" that users don't mix uploaded and synced deb content in a single Katello repository. In the GUI we have a soft enforcement of this preference: If a repo has an "Upstream URL" set (configured for syncing), then the upload box contains the following message (won't let you upload):

If you want to upload individual packages, create a separate repository with an empty "Upstream URL" field.

You can work around this by removing and re-adding the Upstream URL, and we don't have any such enforcement for Hammer CLI uploads. We did once discuss making enforcement stricter, but never got around to actually implementing that.

My point is: Currently these new upload docs don't mention any of this at all, and I think they should? Otherwise we are encouraging users to start using the feature in a way that we don't want them to use it.

We may also want to meet up to discuss the background in more detail?

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

Labels

Needs style review Requires a review from docs style/grammar perspective Needs tech review Requires a review from the technical perspective testing done No issues from the functional perspective

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants