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

docs(manager/dockerfile): Document supported dependencies for Dockerfile manager #32288

Conversation

malmor
Copy link
Contributor

@malmor malmor commented Nov 1, 2024

Changes

This pull requests adds a Supported dependencies section to the Dockerfile manager documentation.

Context

The Dockerfile manager supports many different types of dependencies out of the box. This pull requests adds them to the documentation. I tested the different types of updates (FROM, COPY --from, syntax) and ensured they actually work as expected.

This pull request also fixes a small code highlighting issue in the Flux manager documentation (' was being used instead of ` for two of the resources).

Closes #29872

Documentation (please check one with an [x])

  • I have updated the documentation, or
  • No documentation update is required

How I've tested my work (please select one)

I have verified these changes via:

  • Code inspection only, or
  • Newly added/modified unit tests, or
  • No unit tests but ran on a real repository, or
  • Both unit tests + ran on a real repository

lib/modules/manager/flux/readme.md Outdated Show resolved Hide resolved
@rarkins rarkins requested a review from HonkingGoose November 2, 2024 10:48
Copy link
Collaborator

@HonkingGoose HonkingGoose left a comment

Choose a reason for hiding this comment

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

Changes:

  • Use a plain list.
  • One sentence per line.
  • Rewrite to shorten sentences, and use simpler words.

Good catch on the bad code styling in the other docs page!

lib/modules/manager/dockerfile/readme.md Outdated Show resolved Hide resolved
lib/modules/manager/dockerfile/readme.md Outdated Show resolved Hide resolved
lib/modules/manager/dockerfile/readme.md Outdated Show resolved Hide resolved
lib/modules/manager/dockerfile/readme.md Outdated Show resolved Hide resolved
lib/modules/manager/dockerfile/readme.md Outdated Show resolved Hide resolved
@malmor malmor requested a review from HonkingGoose November 3, 2024 17:34
@rarkins rarkins enabled auto-merge November 3, 2024 17:51
@rarkins rarkins added this pull request to the merge queue Nov 3, 2024
Merged via the queue into renovatebot:main with commit c73a741 Nov 3, 2024
39 checks passed
@renovate-release
Copy link
Collaborator

🎉 This PR is included in version 38.142.6 🎉

The release is available on:

Your semantic-release bot 📦🚀

@github-actions github-actions bot locked as resolved and limited conversation to collaborators Dec 5, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Explain ARG IMAGE= updates in dockerfile manager docs
4 participants