Skip to content

Conversation

maximiliankolb
Copy link
Contributor

What changes are you introducing?

Users should never clone and edit templates. Instead, if they really need to run custom code before or after registration or provisioning workflows, they should use "custom pre" and "custom post" snippets as documented. This way they do not lose support by the community/vendor.

Also, there's configuration management.

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

Fixes #4256

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

Should we also drop the hint about cloning and editing in guides/common/modules/proc_setting-up-job-templates.adoc?

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

Users should never clone and edit templates. Instead, if they really
need to run custom code before or after registration or provisioning
workflows, they should use "custom pre" and "custom post" snippets as
documented. This way they do not lose support by the community/vendor.

Also, there's configuration management.

Fixes theforeman#4256
@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 Sep 24, 2025
@Lennonka
Copy link
Contributor

Should we also drop the hint about cloning and editing in job templates

I'm not sure if job templates support custom snippets the same way as provisioning templates. That would require further research.

Copy link
Contributor

@Lennonka Lennonka left a comment

Choose a reason for hiding this comment

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

The change LGTM, but I would appreciate a tech ack.

@Lennonka Lennonka added style review done No issues from docs style/grammar perspective and removed Needs style review Requires a review from docs style/grammar perspective labels Sep 26, 2025
@maximiliankolb maximiliankolb removed the Needs testing Requires functional testing label Sep 26, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Needs tech review Requires a review from the technical perspective style review done No issues from docs style/grammar perspective
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Recommend custom pre/custom post snippets in favor of cloning+editing templates
2 participants