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.

Sign up for GitHub

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

Jump to bottom

chore: enhance debugging docs #945

Merged

cmwylie19 merged 24 commits into main from debugging-856

Jul 17, 2024

Collaborator

cmwylie19 commented Jul 9, 2024 •

edited

Loading

Description

Enhance Pepr debugging docs with more scenarios.

Related Issue

Fixes #856

Type of change

Bug fix (non-breaking change which fixes an issue)
New feature (non-breaking change which adds functionality)
Other (security config, docs update, etc)

Checklist before merging

Test, docs, adr added or updated as needed
Contributor Guide Steps followed

cmwylie19 added 8 commits

July 9, 2024 18:50


          chore: docs

0373e02

Signed-off-by: Case Wylie <cmwylie19@defenseunicorns.com>


          chore: add resources

d5ef09f

Signed-off-by: Case Wylie <cmwylie19@defenseunicorns.com>


          Update docs/060_best-practices/README.md

d8d2920


          Update docs/060_best-practices/README.md

81cb26e


          Update docs/060_best-practices/README.md

b8ed70e


          Update docs/060_best-practices/README.md

9632e91


          chore: fix error

d384a82

Signed-off-by: Case Wylie <cmwylie19@defenseunicorns.com>


          chore: updates

664175f

Signed-off-by: Case Wylie <cmwylie19@defenseunicorns.com>

cmwylie19 requested review from jeff-mccoy, btlghrants and schaeferka as code owners

July 9, 2024 23:04

cmwylie19 changed the title ~~freat: enhance debugging docs~~ feat: enhance debugging docs

cmwylie19 added 2 commits

July 10, 2024 13:28


          chore: debugging-856

04c08a8

Signed-off-by: Case Wylie <cmwylie19@defenseunicorns.com>


          Merge branch 'main' into debugging-856

9c731aa

cmwylie19 changed the title ~~feat: enhance debugging docs~~ chore: enhance debugging docs

Collaborator Author

cmwylie19 commented Jul 10, 2024

changed from feat to chore since the docs already existed and this PR only elaborates on them

cmwylie19 added 3 commits

July 15, 2024 11:27


          Merge branch 'main' into debugging-856

7f8efc0


          chore:fix json

89a0824

Signed-off-by: Case Wylie <cmwylie19@defenseunicorns.com>


          Merge branch 'main' into debugging-856

c41ab6c

btlghrants reviewed

View reviewed changes

docs/060_best-practices/README.md Outdated Show resolved Hide resolved

docs/060_best-practices/README.md Show resolved Hide resolved

docs/060_best-practices/README.md Outdated Show resolved Hide resolved

docs/060_best-practices/README.md Outdated Show resolved Hide resolved

docs/060_best-practices/README.md Outdated Show resolved Hide resolved

docs/060_best-practices/README.md Outdated Show resolved Hide resolved

docs/060_best-practices/README.md Outdated Show resolved Hide resolved

docs/060_best-practices/README.md Outdated Show resolved Hide resolved

docs/060_best-practices/README.md Outdated Show resolved Hide resolved

docs/060_best-practices/README.md Outdated Show resolved Hide resolved

cmwylie19 added 2 commits

July 16, 2024 10:20


          chore: address comments

0ef4bad

Signed-off-by: Case Wylie <cmwylie19@defenseunicorns.com>


          Merge branch 'main' into debugging-856

99f2440

cmwylie19 commented

View reviewed changes

docs/060_best-practices/README.md Outdated Show resolved Hide resolved


          Update docs/060_best-practices/README.md

502f4de

btlghrants reviewed

View reviewed changes

docs/060_best-practices/README.md Outdated Show resolved Hide resolved

cmwylie19 and others added 3 commits

July 17, 2024 11:05


          Update docs/060_best-practices/README.md

96de325

Co-authored-by: Barrett <81570928+btlghrants@users.noreply.github.com>


          Update docs/060_best-practices/README.md

19b7c42

Co-authored-by: Barrett <81570928+btlghrants@users.noreply.github.com>


          Update docs/060_best-practices/README.md

11f4d66

Co-authored-by: Barrett <81570928+btlghrants@users.noreply.github.com>

cmwylie19 commented

View reviewed changes

docs/060_best-practices/README.md Outdated Show resolved Hide resolved


          Update docs/060_best-practices/README.md

815a639

redundant

cmwylie19 commented

View reviewed changes

docs/060_best-practices/README.md Outdated Show resolved Hide resolved

cmwylie19 commented

View reviewed changes

docs/060_best-practices/README.md Outdated Show resolved Hide resolved

cmwylie19 added 2 commits

July 17, 2024 11:07


          Update docs/060_best-practices/README.md

a0e289e


          Update docs/060_best-practices/README.md

10f6afa

cmwylie19 commented

View reviewed changes

docs/060_best-practices/README.md Outdated Show resolved Hide resolved


          Update docs/060_best-practices/README.md

5ed0452

btlghrants approved these changes

View reviewed changes

Collaborator

btlghrants left a comment

LG


          Merge branch 'main' into debugging-856

891e784

cmwylie19 merged commit 98fca3e into main

13 checks passed

cmwylie19 deleted the debugging-856 branch

July 17, 2024 15:38

mjnagel referenced this pull request in defenseunicorns/uds-core


          chore(deps): update pepr to 0.33.0 (#588)

6eee8f0

[![Mend
Renovate](https://app.renovatebot.com/images/banner.svg)](https://renovatebot.com)

This PR contains the following updates:

| Package | Type | Update | Change | Age | Adoption | Passing |
Confidence |
|---|---|---|---|---|---|---|---|
|
[defenseunicorns/uds-common](https://togithub.com/defenseunicorns/uds-common)
| | minor | `v0.8.0` -> `v0.11.1` |
[![age](https://developer.mend.io/api/mc/badges/age/github-tags/defenseunicorns%2fuds-common/v0.11.1?slim=true)](https://docs.renovatebot.com/merge-confidence/)
|
[![adoption](https://developer.mend.io/api/mc/badges/adoption/github-tags/defenseunicorns%2fuds-common/v0.11.1?slim=true)](https://docs.renovatebot.com/merge-confidence/)
|
[![passing](https://developer.mend.io/api/mc/badges/compatibility/github-tags/defenseunicorns%2fuds-common/v0.8.0/v0.11.1?slim=true)](https://docs.renovatebot.com/merge-confidence/)
|
[![confidence](https://developer.mend.io/api/mc/badges/confidence/github-tags/defenseunicorns%2fuds-common/v0.8.0/v0.11.1?slim=true)](https://docs.renovatebot.com/merge-confidence/)
|
| [pepr](https://togithub.com/defenseunicorns/pepr) | dependencies |
minor | [`0.32.7` ->
`0.33.0`](https://renovatebot.com/diffs/npm/pepr/0.32.7/0.33.0) |
[![age](https://developer.mend.io/api/mc/badges/age/npm/pepr/0.33.0?slim=true)](https://docs.renovatebot.com/merge-confidence/)
|
[![adoption](https://developer.mend.io/api/mc/badges/adoption/npm/pepr/0.33.0?slim=true)](https://docs.renovatebot.com/merge-confidence/)
|
[![passing](https://developer.mend.io/api/mc/badges/compatibility/npm/pepr/0.32.7/0.33.0?slim=true)](https://docs.renovatebot.com/merge-confidence/)
|
[![confidence](https://developer.mend.io/api/mc/badges/confidence/npm/pepr/0.32.7/0.33.0?slim=true)](https://docs.renovatebot.com/merge-confidence/)
|
|
[registry1.dso.mil/ironbank/opensource/defenseunicorns/pepr/controller](https://togithub.com/defenseunicorns/pepr)
([source](https://repo1.dso.mil/dsop/opensource/defenseunicorns/pepr/controller))
| | minor | `v0.32.7` -> `v0.33.0` |
[![age](https://developer.mend.io/api/mc/badges/age/docker/registry1.dso.mil%2fironbank%2fopensource%2fdefenseunicorns%2fpepr%2fcontroller/v0.33.0?slim=true)](https://docs.renovatebot.com/merge-confidence/)
|
[![adoption](https://developer.mend.io/api/mc/badges/adoption/docker/registry1.dso.mil%2fironbank%2fopensource%2fdefenseunicorns%2fpepr%2fcontroller/v0.33.0?slim=true)](https://docs.renovatebot.com/merge-confidence/)
|
[![passing](https://developer.mend.io/api/mc/badges/compatibility/docker/registry1.dso.mil%2fironbank%2fopensource%2fdefenseunicorns%2fpepr%2fcontroller/v0.32.7/v0.33.0?slim=true)](https://docs.renovatebot.com/merge-confidence/)
|
[![confidence](https://developer.mend.io/api/mc/badges/confidence/docker/registry1.dso.mil%2fironbank%2fopensource%2fdefenseunicorns%2fpepr%2fcontroller/v0.32.7/v0.33.0?slim=true)](https://docs.renovatebot.com/merge-confidence/)
|
| [ts-jest](https://kulshekhar.github.io/ts-jest)
([source](https://togithub.com/kulshekhar/ts-jest)) | devDependencies |
patch | [`29.2.2` ->
`29.2.4`](https://renovatebot.com/diffs/npm/ts-jest/29.2.2/29.2.4) |
[![age](https://developer.mend.io/api/mc/badges/age/npm/ts-jest/29.2.4?slim=true)](https://docs.renovatebot.com/merge-confidence/)
|
[![adoption](https://developer.mend.io/api/mc/badges/adoption/npm/ts-jest/29.2.4?slim=true)](https://docs.renovatebot.com/merge-confidence/)
|
[![passing](https://developer.mend.io/api/mc/badges/compatibility/npm/ts-jest/29.2.2/29.2.4?slim=true)](https://docs.renovatebot.com/merge-confidence/)
|
[![confidence](https://developer.mend.io/api/mc/badges/confidence/npm/ts-jest/29.2.2/29.2.4?slim=true)](https://docs.renovatebot.com/merge-confidence/)
|

---

### Release Notes

<details>
<summary>defenseunicorns/uds-common
(defenseunicorns/uds-common)</summary>

###
[`v0.11.1`](https://togithub.com/defenseunicorns/uds-common/releases/tag/v0.11.1)

[Compare
Source](https://togithub.com/defenseunicorns/uds-common/compare/v0.11.0...v0.11.1)

##### Bug Fixes

- renovate ghcr host docker type
([#&#8203;201](https://togithub.com/defenseunicorns/uds-common/issues/201))
([9c298e0](https://togithub.com/defenseunicorns/uds-common/commit/9c298e08417ce928dbbf4356c23182f8b1a62ffb))
- renovate typo token/password
([#&#8203;202](https://togithub.com/defenseunicorns/uds-common/issues/202))
([5d7ea03](https://togithub.com/defenseunicorns/uds-common/commit/5d7ea03815929a662c529b2078bdf895d8f3ac1b))
- update renovate creds
([#&#8203;200](https://togithub.com/defenseunicorns/uds-common/issues/200))
([1c6eb24](https://togithub.com/defenseunicorns/uds-common/commit/1c6eb24f37b4059589a70c9addeffb80895d450b))

##### Miscellaneous

- add renovate support for org ghcr packages
([#&#8203;199](https://togithub.com/defenseunicorns/uds-common/issues/199))
([2c5de9c](https://togithub.com/defenseunicorns/uds-common/commit/2c5de9cc41cad9d1e02faf39c0cad364933f335f))
- **deps:** update uds common support dependencies
([#&#8203;195](https://togithub.com/defenseunicorns/uds-common/issues/195))
([04b6409](https://togithub.com/defenseunicorns/uds-common/commit/04b64091ba0528463713f66d8167572a533e0c3d))
- fix codeowners
([#&#8203;196](https://togithub.com/defenseunicorns/uds-common/issues/196))
([856ef22](https://togithub.com/defenseunicorns/uds-common/commit/856ef221b39e65070e966942b42e79d408f59b76))

###
[`v0.11.0`](https://togithub.com/defenseunicorns/uds-common/releases/tag/v0.11.0)

[Compare
Source](https://togithub.com/defenseunicorns/uds-common/compare/v0.10.0...v0.11.0)

##### Features

- add support for uds-core snapshots
([#&#8203;193](https://togithub.com/defenseunicorns/uds-common/issues/193))
([7a39915](https://togithub.com/defenseunicorns/uds-common/commit/7a39915ceff7a1a9e319846042ab74390fda6f2b))

##### Miscellaneous

- **deps:** update uds common support dependencies
([#&#8203;187](https://togithub.com/defenseunicorns/uds-common/issues/187))
([a0bbfb0](https://togithub.com/defenseunicorns/uds-common/commit/a0bbfb043e670a175fbdc44585e2bbb5b695acf7))

###
[`v0.10.0`](https://togithub.com/defenseunicorns/uds-common/releases/tag/v0.10.0)

[Compare
Source](https://togithub.com/defenseunicorns/uds-common/compare/v0.9.0...v0.10.0)

##### Features

- add task for determining target repo based on flavor
([#&#8203;188](https://togithub.com/defenseunicorns/uds-common/issues/188))
([6810324](https://togithub.com/defenseunicorns/uds-common/commit/681032402a315c8db80975571242ed8db73e78bf))

###
[`v0.9.0`](https://togithub.com/defenseunicorns/uds-common/releases/tag/v0.9.0)

[Compare
Source](https://togithub.com/defenseunicorns/uds-common/compare/v0.8.2...v0.9.0)

##### ⚠ BREAKING CHANGES

-   update doug ci credential for new identity config req

##### Bug Fixes

- update doug ci credential for new identity config req
([71340f7](https://togithub.com/defenseunicorns/uds-common/commit/71340f7d4fc0cd8fd6c44335b54e0b12769965d1))

###
[`v0.8.2`](https://togithub.com/defenseunicorns/uds-common/releases/tag/v0.8.2)

[Compare
Source](https://togithub.com/defenseunicorns/uds-common/compare/v0.8.1...v0.8.2)

##### Miscellaneous

- add additional install step to playwright install
([#&#8203;183](https://togithub.com/defenseunicorns/uds-common/issues/183))
([41855e4](https://togithub.com/defenseunicorns/uds-common/commit/41855e42bd73c67109ed42935f1e67ab7305ddda))
- **deps:** update uds common support dependencies
([#&#8203;179](https://togithub.com/defenseunicorns/uds-common/issues/179))
([e1a0d5a](https://togithub.com/defenseunicorns/uds-common/commit/e1a0d5acba2c0cc083af6ac2823d9cf068008453))
- fix the Zarf package renovate regex to the correct versionTemplate
([#&#8203;181](https://togithub.com/defenseunicorns/uds-common/issues/181))
([272b502](https://togithub.com/defenseunicorns/uds-common/commit/272b502fa2f36b3703f9cdcbdbfb579ce437a0d7))

###
[`v0.8.1`](https://togithub.com/defenseunicorns/uds-common/releases/tag/v0.8.1)

[Compare
Source](https://togithub.com/defenseunicorns/uds-common/compare/v0.8.0...v0.8.1)

##### Miscellaneous

- add cgr identity assume to setup action
([#&#8203;180](https://togithub.com/defenseunicorns/uds-common/issues/180))
([2ec74fb](https://togithub.com/defenseunicorns/uds-common/commit/2ec74fbe496c5cdcc88cd3f424951f11271fe5d6))
- fix version matching for UDS packages
([#&#8203;176](https://togithub.com/defenseunicorns/uds-common/issues/176))
([e068b6a](https://togithub.com/defenseunicorns/uds-common/commit/e068b6a255cc856e313485826a2140a3977c6b03))

</details>

<details>
<summary>defenseunicorns/pepr (pepr)</summary>

###
[`v0.33.0`](https://togithub.com/defenseunicorns/pepr/releases/tag/v0.33.0)

[Compare
Source](https://togithub.com/defenseunicorns/pepr/compare/v0.32.7...v0.33.0)

#### Features

- feat: sanitizing store keys - store path v2 by
[@&#8203;cmwylie19](https://togithub.com/cmwylie19) in
[https://github.com/defenseunicorns/pepr/pull/918](https://togithub.com/defenseunicorns/pepr/pull/918)
- feat: merge package env vars by
[@&#8203;cmwylie19](https://togithub.com/cmwylie19) in
[https://github.com/defenseunicorns/pepr/pull/963](https://togithub.com/defenseunicorns/pepr/pull/963)

#### What's Changed

- chore: update docs around punycode warning by
[@&#8203;cmwylie19](https://togithub.com/cmwylie19) in
[https://github.com/defenseunicorns/pepr/pull/960](https://togithub.com/defenseunicorns/pepr/pull/960)
- chore: enhance debugging docs by
[@&#8203;cmwylie19](https://togithub.com/cmwylie19) in
[https://github.com/defenseunicorns/pepr/pull/945](https://togithub.com/defenseunicorns/pepr/pull/945)
- chore: update store adr by
[@&#8203;cmwylie19](https://togithub.com/cmwylie19) in
[https://github.com/defenseunicorns/pepr/pull/958](https://togithub.com/defenseunicorns/pepr/pull/958)
- chore: add date to license by
[@&#8203;cmwylie19](https://togithub.com/cmwylie19) in
[https://github.com/defenseunicorns/pepr/pull/957](https://togithub.com/defenseunicorns/pepr/pull/957)
- chore: bump actions/dependency-review-action from 4.3.3 to 4.3.4 by
[@&#8203;dependabot](https://togithub.com/dependabot) in
[https://github.com/defenseunicorns/pepr/pull/952](https://togithub.com/defenseunicorns/pepr/pull/952)
- chore: bump fast-check from 3.19.0 to 3.20.0 in the
development-dependencies group by
[@&#8203;dependabot](https://togithub.com/dependabot) in
[https://github.com/defenseunicorns/pepr/pull/956](https://togithub.com/defenseunicorns/pepr/pull/956)
- chore: bump github/codeql-action from 3.25.11 to 3.25.12 by
[@&#8203;dependabot](https://togithub.com/dependabot) in
[https://github.com/defenseunicorns/pepr/pull/955](https://togithub.com/defenseunicorns/pepr/pull/955)
- chore: bump anchore/scan-action from 4.0.0 to 4.1.0 by
[@&#8203;dependabot](https://togithub.com/dependabot) in
[https://github.com/defenseunicorns/pepr/pull/962](https://togithub.com/defenseunicorns/pepr/pull/962)
- chore: bump pino from 9.2.0 to 9.3.1 in the production-dependencies
group by [@&#8203;dependabot](https://togithub.com/dependabot) in
[https://github.com/defenseunicorns/pepr/pull/961](https://togithub.com/defenseunicorns/pepr/pull/961)
- chore: bump chainguard/node-lts from `ea8ec8f` to `490bcd9` by
[@&#8203;dependabot](https://togithub.com/dependabot) in
[https://github.com/defenseunicorns/pepr/pull/965](https://togithub.com/defenseunicorns/pepr/pull/965)
- chore: bump [@&#8203;types/node](https://togithub.com/types/node) from
18.19.39 to 18.19.40 in the development-dependencies group by
[@&#8203;dependabot](https://togithub.com/dependabot) in
[https://github.com/defenseunicorns/pepr/pull/964](https://togithub.com/defenseunicorns/pepr/pull/964)
- chore: bump docker/login-action from 3.2.0 to 3.3.0 by
[@&#8203;dependabot](https://togithub.com/dependabot) in
[https://github.com/defenseunicorns/pepr/pull/973](https://togithub.com/defenseunicorns/pepr/pull/973)
- chore: bump chainguard/node-lts from `490bcd9` to `4db5b44` by
[@&#8203;dependabot](https://togithub.com/dependabot) in
[https://github.com/defenseunicorns/pepr/pull/967](https://togithub.com/defenseunicorns/pepr/pull/967)
- chore: bump docker/setup-buildx-action from 3.4.0 to 3.5.0 by
[@&#8203;dependabot](https://togithub.com/dependabot) in
[https://github.com/defenseunicorns/pepr/pull/972](https://togithub.com/defenseunicorns/pepr/pull/972)
- chore: bump step-security/harden-runner from 2.8.1 to 2.9.0 by
[@&#8203;dependabot](https://togithub.com/dependabot) in
[https://github.com/defenseunicorns/pepr/pull/969](https://togithub.com/defenseunicorns/pepr/pull/969)
- chore: bump github/codeql-action from 3.25.12 to 3.25.13 by
[@&#8203;dependabot](https://togithub.com/dependabot) in
[https://github.com/defenseunicorns/pepr/pull/971](https://togithub.com/defenseunicorns/pepr/pull/971)
- chore: bump kubernetes-fluent-client from 2.6.4 to 2.6.5 in the
production-dependencies group by
[@&#8203;dependabot](https://togithub.com/dependabot) in
[https://github.com/defenseunicorns/pepr/pull/976](https://togithub.com/defenseunicorns/pepr/pull/976)
- chore: bump the development-dependencies group across 1 directory with
3 updates by [@&#8203;dependabot](https://togithub.com/dependabot) in
[https://github.com/defenseunicorns/pepr/pull/974](https://togithub.com/defenseunicorns/pepr/pull/974)

**Full Changelog**:
defenseunicorns/pepr@v0.32.7...v0.33.0

</details>

<details>
<summary>kulshekhar/ts-jest (ts-jest)</summary>

###
[`v29.2.4`](https://togithub.com/kulshekhar/ts-jest/blob/HEAD/CHANGELOG.md#2924-2024-08-01)

[Compare
Source](https://togithub.com/kulshekhar/ts-jest/compare/v29.2.3...v29.2.4)

###
[`v29.2.3`](https://togithub.com/kulshekhar/ts-jest/blob/HEAD/CHANGELOG.md#2923-2024-07-18)

[Compare
Source](https://togithub.com/kulshekhar/ts-jest/compare/v29.2.2...v29.2.3)

</details>

---

### Configuration

📅 **Schedule**: Branch creation - At any time (no schedule defined),
Automerge - At any time (no schedule defined).

🚦 **Automerge**: Disabled by config. Please merge this manually once you
are satisfied.

♻ **Rebasing**: Whenever PR becomes conflicted, or you tick the
rebase/retry checkbox.

👻 **Immortal**: This PR will be recreated if closed unmerged. Get
[config help](https://togithub.com/renovatebot/renovate/discussions) if
that's undesired.

---

- [ ] <!-- rebase-check -->If you want to rebase/retry this PR, check
this box

---

This PR was generated by [Mend
Renovate](https://www.mend.io/free-developer-tools/renovate/). View the
[repository job
log](https://developer.mend.io/github/defenseunicorns/uds-core).

<!--renovate-debug:eyJjcmVhdGVkSW5WZXIiOiIzNy40MzEuNCIsInVwZGF0ZWRJblZlciI6IjM4LjE4LjE3IiwidGFyZ2V0QnJhbmNoIjoibWFpbiIsImxhYmVscyI6W119-->

Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
Co-authored-by: Micah Nagel <micah.nagel@defenseunicorns.com>

cmwylie19 self-assigned this

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

Labels

None yet