Skip to content

chore: proper messaging on disabling ryuk#566

Merged
mdelapenya merged 6 commits intotestcontainers:mainfrom
mdelapenya:ryuk-banner
Oct 16, 2022
Merged

chore: proper messaging on disabling ryuk#566
mdelapenya merged 6 commits intotestcontainers:mainfrom
mdelapenya:ryuk-banner

Conversation

@mdelapenya
Copy link
Copy Markdown
Member

What does this PR do?

It does :

  • prints a simple banner if Ryuk is skipped for a container or a network, displaying a link to the docs.
  • changes the block section for the reaper in the docs from a tip to a warning, including reasons why it's not recommended to disable Ryuk.

Why is it important?

In the light of #561, good conversations have appeared around disabling Ryuk. For that reason, we are improving the docs and the outcomes of disabling Ryuk at the container request.

@mdelapenya mdelapenya requested a review from a team as a code owner October 13, 2022 16:20
@mdelapenya mdelapenya added documentation Docs, docs, docs. chore Changes that do not impact the existing functionality labels Oct 13, 2022
@mdelapenya mdelapenya self-assigned this Oct 13, 2022
@codecov
Copy link
Copy Markdown

codecov bot commented Oct 13, 2022

Codecov Report

Merging #566 (e232916) into main (b798926) will decrease coverage by 0.27%.
The diff coverage is 69.23%.

@@            Coverage Diff             @@
##             main     #566      +/-   ##
==========================================
- Coverage   69.30%   69.02%   -0.28%     
==========================================
  Files          22       22              
  Lines        2186     2202      +16     
==========================================
+ Hits         1515     1520       +5     
- Misses        534      543       +9     
- Partials      137      139       +2     
Impacted Files Coverage Δ
docker.go 71.62% <69.23%> (-0.66%) ⬇️

📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more

@mdelapenya mdelapenya merged commit b70166b into testcontainers:main Oct 16, 2022
@mdelapenya mdelapenya deleted the ryuk-banner branch October 16, 2022 06:41
@mdelapenya mdelapenya added feature New functionality or new behaviors on the existing one and removed chore Changes that do not impact the existing functionality labels Oct 21, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Docs, docs, docs. feature New functionality or new behaviors on the existing one

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants