docs: add cleanup docs (cherry-pick #1368) #1371
Merged
+151
−4
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
![gcp-cherry-pick-bot[bot]](https://avatars.githubusercontent.com/in/169664?s=60&v=4){kind=small}
Signed-off-by: Charles-Edouard Brétéché <charles.edouard@nirmata.com>
eddycharly
approved these changes
May 21, 2024
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## release-0.2 #1371 +/- ##
============================================
Coverage 75.30% 75.30%
============================================
Files 132 132
Lines 4706 4706
============================================
Hits 3544 3544
Misses 883 883
Partials 279 279 ☔ View full report in Codecov by Sentry. |
renovate bot
added a commit
to anza-labs/lke-operator
that referenced
this pull request
May 22, 2024
[](https://renovatebot.com) This PR contains the following updates: | Package | Change | Age | Adoption | Passing | Confidence | |---|---|---|---|---|---| | [github.com/kyverno/chainsaw](https://togithub.com/kyverno/chainsaw) | `v0.2.0` -> `v0.2.2` | [](https://docs.renovatebot.com/merge-confidence/) | [](https://docs.renovatebot.com/merge-confidence/) | [](https://docs.renovatebot.com/merge-confidence/) | [](https://docs.renovatebot.com/merge-confidence/) | --- ### Release Notes <details> <summary>kyverno/chainsaw (github.com/kyverno/chainsaw)</summary> ### [`v0.2.2`](https://togithub.com/kyverno/chainsaw/releases/tag/v0.2.2) [Compare Source](https://togithub.com/kyverno/chainsaw/compare/v0.2.1...v0.2.2) ####‼️ Breaking changes‼️ - `finally` block now executes when the step terminates. It was supposed to work like this from the beginning but was not properly working. The `cleanup` block was introduced to execute operations when a test terminates instead. #### 💫 New features 💫 - Added cleanup handlers support to register custom cleanup operations to run when a test terminates #### 🔧 Fixes 🔧 - Use `namespaceTemplate` from configuration if provided #### 📚 Docs 📚 - Improved home page - Added scroll to top button - Improved navigation bar - Fixed dark/light color schemes and added system preference support - Added links to Slack and X/Twitter links in the footer - Removed the blog - Rewrote most of the Getting Started pages #### What's Changed - fix: Use config file namespaceTemplate if set (cherry-pick [#​1279](https://togithub.com/kyverno/chainsaw/issues/1279)) by [@​gcp-cherry-pick-bot](https://togithub.com/gcp-cherry-pick-bot) in [kyverno/chainsaw#1293 - feat: improve home page (cherry-pick [#​1292](https://togithub.com/kyverno/chainsaw/issues/1292)) by [@​gcp-cherry-pick-bot](https://togithub.com/gcp-cherry-pick-bot) in [kyverno/chainsaw#1297 - fix: disable instant nav (cherry-pick [#​1298](https://togithub.com/kyverno/chainsaw/issues/1298)) by [@​gcp-cherry-pick-bot](https://togithub.com/gcp-cherry-pick-bot) in [kyverno/chainsaw#1299 - fix: improve home page (cherry-pick [#​1300](https://togithub.com/kyverno/chainsaw/issues/1300)) by [@​gcp-cherry-pick-bot](https://togithub.com/gcp-cherry-pick-bot) in [kyverno/chainsaw#1301 - fix: mike (cherry-pick [#​1302](https://togithub.com/kyverno/chainsaw/issues/1302)) by [@​gcp-cherry-pick-bot](https://togithub.com/gcp-cherry-pick-bot) in [kyverno/chainsaw#1304 - fix: improve home (cherry-pick [#​1303](https://togithub.com/kyverno/chainsaw/issues/1303)) by [@​gcp-cherry-pick-bot](https://togithub.com/gcp-cherry-pick-bot) in [kyverno/chainsaw#1305 - chore: remove blog (cherry-pick [#​1310](https://togithub.com/kyverno/chainsaw/issues/1310)) by [@​gcp-cherry-pick-bot](https://togithub.com/gcp-cherry-pick-bot) in [kyverno/chainsaw#1311 - chore: move community page to its own tab (cherry-pick [#​1312](https://togithub.com/kyverno/chainsaw/issues/1312)) by [@​gcp-cherry-pick-bot](https://togithub.com/gcp-cherry-pick-bot) in [kyverno/chainsaw#1313 - chore: improve install page (cherry-pick [#​1315](https://togithub.com/kyverno/chainsaw/issues/1315)) by [@​gcp-cherry-pick-bot](https://togithub.com/gcp-cherry-pick-bot) in [kyverno/chainsaw#1317 - chore(deps): Bump actions/checkout from 4.1.5 to 4.1.6 (cherry-pick [#​1316](https://togithub.com/kyverno/chainsaw/issues/1316)) by [@​gcp-cherry-pick-bot](https://togithub.com/gcp-cherry-pick-bot) in [kyverno/chainsaw#1318 - chore: add missing adopters to the home page (cherry-pick [#​1319](https://togithub.com/kyverno/chainsaw/issues/1319)) by [@​gcp-cherry-pick-bot](https://togithub.com/gcp-cherry-pick-bot) in [kyverno/chainsaw#1320 - chore: rework introduction (cherry-pick [#​1321](https://togithub.com/kyverno/chainsaw/issues/1321)) by [@​gcp-cherry-pick-bot](https://togithub.com/gcp-cherry-pick-bot) in [kyverno/chainsaw#1322 - chore: add resource templating into (cherry-pick [#​1323](https://togithub.com/kyverno/chainsaw/issues/1323)) by [@​gcp-cherry-pick-bot](https://togithub.com/gcp-cherry-pick-bot) in [kyverno/chainsaw#1324 - chore: improve assertions quick start (cherry-pick [#​1326](https://togithub.com/kyverno/chainsaw/issues/1326)) by [@​gcp-cherry-pick-bot](https://togithub.com/gcp-cherry-pick-bot) in [kyverno/chainsaw#1329 - chore: restructure the getting started guide (cherry-pick [#​1330](https://togithub.com/kyverno/chainsaw/issues/1330)) by [@​gcp-cherry-pick-bot](https://togithub.com/gcp-cherry-pick-bot) in [kyverno/chainsaw#1331 - chore: improve next steps page (cherry-pick [#​1332](https://togithub.com/kyverno/chainsaw/issues/1332)) by [@​gcp-cherry-pick-bot](https://togithub.com/gcp-cherry-pick-bot) in [kyverno/chainsaw#1333 - chore: improve timeouts quick start (cherry-pick [#​1334](https://togithub.com/kyverno/chainsaw/issues/1334)) by [@​gcp-cherry-pick-bot](https://togithub.com/gcp-cherry-pick-bot) in [kyverno/chainsaw#1335 - chore: improve bindings page (cherry-pick [#​1336](https://togithub.com/kyverno/chainsaw/issues/1336)) by [@​gcp-cherry-pick-bot](https://togithub.com/gcp-cherry-pick-bot) in [kyverno/chainsaw#1337 - chore: improve try catch finally page (cherry-pick [#​1338](https://togithub.com/kyverno/chainsaw/issues/1338)) by [@​gcp-cherry-pick-bot](https://togithub.com/gcp-cherry-pick-bot) in [kyverno/chainsaw#1339 - fix: linter issues (cherry-pick [#​1345](https://togithub.com/kyverno/chainsaw/issues/1345)) by [@​gcp-cherry-pick-bot](https://togithub.com/gcp-cherry-pick-bot) in [kyverno/chainsaw#1346 - chore(deps): Bump github/codeql-action from 2.13.4 to 3.25.5 (cherry-pick [#​1342](https://togithub.com/kyverno/chainsaw/issues/1342)) by [@​gcp-cherry-pick-bot](https://togithub.com/gcp-cherry-pick-bot) in [kyverno/chainsaw#1344 - chore(deps): Bump github/codeql-action from 3.25.5 to 3.25.6 (cherry-pick [#​1350](https://togithub.com/kyverno/chainsaw/issues/1350)) by [@​gcp-cherry-pick-bot](https://togithub.com/gcp-cherry-pick-bot) in [kyverno/chainsaw#1353 - chore(deps): Bump codecov/codecov-action from 4.4.0 to 4.4.1 (cherry-pick [#​1348](https://togithub.com/kyverno/chainsaw/issues/1348)) by [@​gcp-cherry-pick-bot](https://togithub.com/gcp-cherry-pick-bot) in [kyverno/chainsaw#1356 - docs: resource templating docs (cherry-pick [#​1354](https://togithub.com/kyverno/chainsaw/issues/1354)) by [@​gcp-cherry-pick-bot](https://togithub.com/gcp-cherry-pick-bot) in [kyverno/chainsaw#1357 - chore(deps): Bump anchore/sbom-action from 0.15.11 to 0.16.0 (cherry-pick [#​1349](https://togithub.com/kyverno/chainsaw/issues/1349)) by [@​gcp-cherry-pick-bot](https://togithub.com/gcp-cherry-pick-bot) in [kyverno/chainsaw#1359 - docs: operation outputs page (cherry-pick [#​1358](https://togithub.com/kyverno/chainsaw/issues/1358)) by [@​gcp-cherry-pick-bot](https://togithub.com/gcp-cherry-pick-bot) in [kyverno/chainsaw#1360 - docs: add placeholder for advanced use cases (cherry-pick [#​1361](https://togithub.com/kyverno/chainsaw/issues/1361)) by [@​gcp-cherry-pick-bot](https://togithub.com/gcp-cherry-pick-bot) in [kyverno/chainsaw#1363 - fix: catch/finally execution order (cherry-pick [#​1351](https://togithub.com/kyverno/chainsaw/issues/1351)) by [@​gcp-cherry-pick-bot](https://togithub.com/gcp-cherry-pick-bot) in [kyverno/chainsaw#1362 - feat: add cleanup handler (cherry-pick [#​1364](https://togithub.com/kyverno/chainsaw/issues/1364)) by [@​gcp-cherry-pick-bot](https://togithub.com/gcp-cherry-pick-bot) in [kyverno/chainsaw#1367 - chore: update release notes (cherry-pick [#​1369](https://togithub.com/kyverno/chainsaw/issues/1369)) by [@​gcp-cherry-pick-bot](https://togithub.com/gcp-cherry-pick-bot) in [kyverno/chainsaw#1372 - docs: add cleanup docs (cherry-pick [#​1368](https://togithub.com/kyverno/chainsaw/issues/1368)) by [@​gcp-cherry-pick-bot](https://togithub.com/gcp-cherry-pick-bot) in [kyverno/chainsaw#1371 - release: v0.2.2 (cherry-pick [#​1376](https://togithub.com/kyverno/chainsaw/issues/1376)) by [@​gcp-cherry-pick-bot](https://togithub.com/gcp-cherry-pick-bot) in [kyverno/chainsaw#1377 **Full Changelog**: kyverno/chainsaw@v0.2.1...v0.2.2 ### [`v0.2.1`](https://togithub.com/kyverno/chainsaw/releases/tag/v0.2.1) [Compare Source](https://togithub.com/kyverno/chainsaw/compare/v0.2.0...v0.2.1) ####‼️ Breaking changes‼️ - Resource templating is now enabled by default #### 💫 New features 💫 - Added `--pause-on-failure` flag to pause when a test failure happens (to ease troubleshooting) - Improved cleanup management logic, alternating `catch`, `finally` and `@cleanup` per step - Added support for registering clusters dynamically, useful when a cluster is created in a test step #### 🔧 Fixes 🔧 - Fixed issue with cluster incorrectly registered - Force background deletion propagation policy (useful when testing unmanaged `Job`) #### What's Changed - chore: update issue templates (cherry-pick [#​1238](https://togithub.com/kyverno/chainsaw/issues/1238)) by [@​gcp-cherry-pick-bot](https://togithub.com/gcp-cherry-pick-bot) in [kyverno/chainsaw#1239 - chore(deps): Bump anchore/sbom-action from 0.15.10 to 0.15.11 (cherry-pick [#​1229](https://togithub.com/kyverno/chainsaw/issues/1229)) by [@​gcp-cherry-pick-bot](https://togithub.com/gcp-cherry-pick-bot) in [kyverno/chainsaw#1240 - chore(deps): Bump codecov/codecov-action from 4.3.0 to 4.3.1 (cherry-pick [#​1233](https://togithub.com/kyverno/chainsaw/issues/1233)) by [@​gcp-cherry-pick-bot](https://togithub.com/gcp-cherry-pick-bot) in [kyverno/chainsaw#1241 - chore(deps): Bump golangci/golangci-lint-action from 5.0.0 to 5.1.0 (cherry-pick [#​1230](https://togithub.com/kyverno/chainsaw/issues/1230)) by [@​gcp-cherry-pick-bot](https://togithub.com/gcp-cherry-pick-bot) in [kyverno/chainsaw#1243 - chore(deps): Bump actions/setup-go from 5.0.0 to 5.0.1 (cherry-pick [#​1245](https://togithub.com/kyverno/chainsaw/issues/1245)) by [@​gcp-cherry-pick-bot](https://togithub.com/gcp-cherry-pick-bot) in [kyverno/chainsaw#1246 - feat: add pause on failure option (cherry-pick [#​1247](https://togithub.com/kyverno/chainsaw/issues/1247)) by [@​gcp-cherry-pick-bot](https://togithub.com/gcp-cherry-pick-bot) in [kyverno/chainsaw#1248 - chore(deps): Bump golangci/golangci-lint-action from 5.1.0 to 5.3.0 (cherry-pick [#​1250](https://togithub.com/kyverno/chainsaw/issues/1250)) by [@​gcp-cherry-pick-bot](https://togithub.com/gcp-cherry-pick-bot) in [kyverno/chainsaw#1251 - chore(deps): Bump zgosalvez/github-actions-ensure-sha-pinned-actions from 3.0.4 to 3.0.5 (cherry-pick [#​1249](https://togithub.com/kyverno/chainsaw/issues/1249)) by [@​gcp-cherry-pick-bot](https://togithub.com/gcp-cherry-pick-bot) in [kyverno/chainsaw#1252 - chore(deps): Bump actions/checkout from 4.1.4 to 4.1.5 (cherry-pick [#​1254](https://togithub.com/kyverno/chainsaw/issues/1254)) by [@​gcp-cherry-pick-bot](https://togithub.com/gcp-cherry-pick-bot) in [kyverno/chainsaw#1259 - chore(deps): Bump golangci/golangci-lint-action from 5.3.0 to 6.0.1 (cherry-pick [#​1257](https://togithub.com/kyverno/chainsaw/issues/1257)) by [@​gcp-cherry-pick-bot](https://togithub.com/gcp-cherry-pick-bot) in [kyverno/chainsaw#1260 - chore(deps): Bump aquasecurity/trivy-action from 0.19.0 to 0.20.0 (cherry-pick [#​1258](https://togithub.com/kyverno/chainsaw/issues/1258)) by [@​gcp-cherry-pick-bot](https://togithub.com/gcp-cherry-pick-bot) in [kyverno/chainsaw#1261 - feat: enable templating by default (cherry-pick [#​1264](https://togithub.com/kyverno/chainsaw/issues/1264)) by [@​gcp-cherry-pick-bot](https://togithub.com/gcp-cherry-pick-bot) in [kyverno/chainsaw#1265 - chore(deps): Bump goreleaser/goreleaser-action from 5.0.0 to 5.1.0 (cherry-pick [#​1266](https://togithub.com/kyverno/chainsaw/issues/1266)) by [@​gcp-cherry-pick-bot](https://togithub.com/gcp-cherry-pick-bot) in [kyverno/chainsaw#1268 - feat: force background propagation deletion (cherry-pick [#​1267](https://togithub.com/kyverno/chainsaw/issues/1267)) by [@​gcp-cherry-pick-bot](https://togithub.com/gcp-cherry-pick-bot) in [kyverno/chainsaw#1269 - feat: add direct cluster config support (cherry-pick [#​1207](https://togithub.com/kyverno/chainsaw/issues/1207)) by [@​gcp-cherry-pick-bot](https://togithub.com/gcp-cherry-pick-bot) in [kyverno/chainsaw#1270 - chore(deps): Bump codecov/codecov-action from 4.3.1 to 4.4.0 (cherry-pick [#​1271](https://togithub.com/kyverno/chainsaw/issues/1271)) by [@​gcp-cherry-pick-bot](https://togithub.com/gcp-cherry-pick-bot) in [kyverno/chainsaw#1273 - chore(deps): Bump github.com/fatih/color from 1.16.0 to 1.17.0 (cherry-pick [#​1272](https://togithub.com/kyverno/chainsaw/issues/1272)) by [@​gcp-cherry-pick-bot](https://togithub.com/gcp-cherry-pick-bot) in [kyverno/chainsaw#1274 - fix: make sure we resolve cluster only once (cherry-pick [#​1276](https://togithub.com/kyverno/chainsaw/issues/1276)) by [@​gcp-cherry-pick-bot](https://togithub.com/gcp-cherry-pick-bot) in [kyverno/chainsaw#1277 - chore: update release notes (cherry-pick [#​1280](https://togithub.com/kyverno/chainsaw/issues/1280)) by [@​gcp-cherry-pick-bot](https://togithub.com/gcp-cherry-pick-bot) in [kyverno/chainsaw#1281 - chore: update docs (cherry-pick [#​1282](https://togithub.com/kyverno/chainsaw/issues/1282)) by [@​gcp-cherry-pick-bot](https://togithub.com/gcp-cherry-pick-bot) in [kyverno/chainsaw#1283 - release: v0.2.1 (cherry-pick [#​1284](https://togithub.com/kyverno/chainsaw/issues/1284)) by [@​gcp-cherry-pick-bot](https://togithub.com/gcp-cherry-pick-bot) in [kyverno/chainsaw#1286 - chore: add v0.2.1 in bug reports template (cherry-pick [#​1285](https://togithub.com/kyverno/chainsaw/issues/1285)) by [@​gcp-cherry-pick-bot](https://togithub.com/gcp-cherry-pick-bot) in [kyverno/chainsaw#1288 - release: v0.2.1 (cherry-pick [#​1287](https://togithub.com/kyverno/chainsaw/issues/1287)) by [@​gcp-cherry-pick-bot](https://togithub.com/gcp-cherry-pick-bot) in [kyverno/chainsaw#1289 **Full Changelog**: kyverno/chainsaw@v0.2.0...v0.2.1 </details> --- ### Configuration 📅 **Schedule**: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined). 🚦 **Automerge**: Enabled. ♻ **Rebasing**: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox. 🔕 **Ignore**: Close this PR and you won't be reminded about this update again. --- - [ ] <!-- rebase-check -->If you want to rebase/retry this PR, check this box --- This PR has been generated by [Mend Renovate](https://www.mend.io/free-developer-tools/renovate/). View repository job log [here](https://developer.mend.io/github/anza-labs/lke-operator). <!--renovate-debug:eyJjcmVhdGVkSW5WZXIiOiIzNy4zNjMuNSIsInVwZGF0ZWRJblZlciI6IjM3LjM2OC4xMCIsInRhcmdldEJyYW5jaCI6Im1haW4iLCJsYWJlbHMiOlsiYXJlYS9kZXBlbmRlbmN5Il19--> Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
](https://renovatebot.com){kind=link}
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Cherry-picked docs: add cleanup docs (#1368)
Signed-off-by: Charles-Edouard Brétéché charles.edouard@nirmata.com