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.

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(docs): correcting cli command in simple demo #549

Merged
merged 1 commit into from
Jul 22, 2024
Merged

chore(docs): correcting cli command in simple demo #549

merged 1 commit into from
Jul 22, 2024

Conversation

ogijaoh
Copy link
Contributor

@ogijaoh ogijaoh commented Jul 22, 2024

Description

Currently the CLI code snippet in step 7 of the Simple Demo refers to the oscal-component-opa.yaml file. The lula evaluate command should provide an assessment results file (or two). The change is to replace oscal-compmonent-opa.yaml with assessment-results.yaml in that code snippet.

Related Issue

Due to simplicity of fix (only a typo in the docs), an issue wasn't needed (per contribution standards, trivial fixes don't require issues).

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

@ogijaoh
correcting cli command text in step 7 of simple demo to read assessme…
ac52fd1 
…nt-results.yaml instead of oscal-component-opa.yaml
@brandtkeller brandtkeller changed the title correcting cli command text in step 7 of simple demo chore(docs): correcting cli command text in step 7 of simple demo Jul 22, 2024
@brandtkeller brandtkeller changed the title chore(docs): correcting cli command text in step 7 of simple demo chore(docs): correcting cli command in simple demo Jul 22, 2024
@brandtkeller brandtkeller added this to the v0.4.4 milestone Jul 22, 2024
brandtkeller
brandtkeller approved these changes Jul 22, 2024
View reviewed changes
Copy link
Member

@brandtkeller brandtkeller left a comment

Choose a reason for hiding this comment

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

Great catch! Thanks for improving the documentation!

@brandtkeller brandtkeller added the open-source Contributed by non-maintainers label Jul 22, 2024
CloudBeard
CloudBeard approved these changes Jul 22, 2024
View reviewed changes
Copy link
Collaborator

@CloudBeard CloudBeard left a comment

Choose a reason for hiding this comment

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

Thanks!

@brandtkeller brandtkeller merged commit 33fb97c into defenseunicorns:main Jul 22, 2024
3 of 4 checks passed
mjnagel referenced this pull request in defenseunicorns/uds-core Aug 2, 2024
@renovate @mjnagel
chore(deps): update lula to v0.4.4 (#615)
b02b305 
[![Mend
Renovate](https://app.renovatebot.com/images/banner.svg)](https://renovatebot.com)

This PR contains the following updates:

| Package | Update | Change |
|---|---|---|
| [defenseunicorns/lula](https://github.com/defenseunicorns/lula) |
patch | `v0.4.3` -> `v0.4.4` |

---

### Release Notes

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

###
[`v0.4.4`](https://github.com/defenseunicorns/lula/releases/tag/v0.4.4)

[Compare
Source](https://github.com/defenseunicorns/lula/compare/v0.4.3...v0.4.4)

This release includes new output during `lula evaluate` through the use
of the `--summary` flag to better highlight areas of improved,
unchanged, or worse compliance-at-a-glance.

OSCAL writes for the current models supported are now written in a
deterministic format. This alleviates long-lived data from being
re-arranged, specifically when stored in version control. Better
highlighting the areas of change as you maintain your OSCAL.

As always - keeping our dependencies - project or pipeline - up to date
is a constant focus of of review.

##### Features

- **evaluate:** add observation summary
([#&#8203;540](https://github.com/defenseunicorns/lula/issues/540))
([8a07833](https://github.com/defenseunicorns/lula/commit/8a07833c5a563d8e857515a083137785cade5eb5))

##### Bug Fixes

- **oscal:** deterministic OSCAL model write
([#&#8203;553](https://github.com/defenseunicorns/lula/issues/553))
([5493df1](https://github.com/defenseunicorns/lula/commit/5493df122b803d11542f29cfe80dfa4d5aaa10a8))

##### Miscellaneous

- **deps:** update github/codeql-action action to v3.25.14
([#&#8203;557](https://github.com/defenseunicorns/lula/issues/557))
([5bfd94f](https://github.com/defenseunicorns/lula/commit/5bfd94febc467e5a455ed32d97ce2e82e20409c2))
- **deps:** update github/codeql-action action to v3.25.15
([#&#8203;564](https://github.com/defenseunicorns/lula/issues/564))
([60e128a](https://github.com/defenseunicorns/lula/commit/60e128a0a34ce8686c67e22ea2aebb61212b97fc))
- **deps:** update golang to version 1.22.5
([#&#8203;562](https://github.com/defenseunicorns/lula/issues/562))
([97ff760](https://github.com/defenseunicorns/lula/commit/97ff7602f30f0709bd2ca16b74e53008607c3a61))
- **deps:** update module github.com/open-policy-agent/opa to v0.67.0
([#&#8203;561](https://github.com/defenseunicorns/lula/issues/561))
([4378242](https://github.com/defenseunicorns/lula/commit/43782420b8b34362d03bcc965e00df2a850715c6))
- **docs:** fix simple demo command for evaluate file
([33fb97c](https://github.com/defenseunicorns/lula/commit/33fb97cccc9d4a589da65c03cc433b4f05c79d5d))
- **docs:** updated broken links
([#&#8203;554](https://github.com/defenseunicorns/lula/issues/554))
([8dd24b0](https://github.com/defenseunicorns/lula/commit/8dd24b083c86b12af8740fe788c4222f4c1c8718))
- **docs:** updated README for docs badge
([#&#8203;558](https://github.com/defenseunicorns/lula/issues/558))
([72fd3fc](https://github.com/defenseunicorns/lula/commit/72fd3fc8137477a4f10507481f8464eb5685b781))

#### What's Changed

- chore(docs): correcting cli command in simple demo by
[@&#8203;ogijaoh](https://github.com/ogijaoh) in
[https://github.com/defenseunicorns/lula/pull/549](https://github.com/defenseunicorns/lula/pull/549)
- docs: updated broken links by
[@&#8203;meganwolf0](https://github.com/meganwolf0) in
[https://github.com/defenseunicorns/lula/pull/554](https://github.com/defenseunicorns/lula/pull/554)
- docs: updated README by
[@&#8203;meganwolf0](https://github.com/meganwolf0) in
[https://github.com/defenseunicorns/lula/pull/558](https://github.com/defenseunicorns/lula/pull/558)
- chore(deps): update github/codeql-action action to v3.25.14 by
[@&#8203;renovate](https://github.com/renovate) in
[https://github.com/defenseunicorns/lula/pull/557](https://github.com/defenseunicorns/lula/pull/557)
- chore(deps): update module github.com/open-policy-agent/opa to v0.67.0
by [@&#8203;renovate](https://github.com/renovate) in
[https://github.com/defenseunicorns/lula/pull/561](https://github.com/defenseunicorns/lula/pull/561)
- chore(deps): update golang to version 1.22.5 by
[@&#8203;brandtkeller](https://github.com/brandtkeller) in
[https://github.com/defenseunicorns/lula/pull/562](https://github.com/defenseunicorns/lula/pull/562)
- feat(evaluate): add observation details by
[@&#8203;meganwolf0](https://github.com/meganwolf0) in
[https://github.com/defenseunicorns/lula/pull/540](https://github.com/defenseunicorns/lula/pull/540)
- fix(oscal): deterministic OSCAL model write by
[@&#8203;brandtkeller](https://github.com/brandtkeller) in
[https://github.com/defenseunicorns/lula/pull/553](https://github.com/defenseunicorns/lula/pull/553)
- chore(deps): update github/codeql-action action to v3.25.15 by
[@&#8203;renovate](https://github.com/renovate) in
[https://github.com/defenseunicorns/lula/pull/564](https://github.com/defenseunicorns/lula/pull/564)
- chore(main): release 0.4.4 by
[@&#8203;github-actions](https://github.com/github-actions) in
[https://github.com/defenseunicorns/lula/pull/546](https://github.com/defenseunicorns/lula/pull/546)

#### New Contributors

- [@&#8203;ogijaoh](https://github.com/ogijaoh) made their first
contribution in
[https://github.com/defenseunicorns/lula/pull/549](https://github.com/defenseunicorns/lula/pull/549)

**Full Changelog**:
defenseunicorns/lula@v0.4.3...v0.4.4

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

🔕 **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 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:eyJjcmVhdGVkSW5WZXIiOiIzNy40MzguMCIsInVwZGF0ZWRJblZlciI6IjM3LjQzOC4wIiwidGFyZ2V0QnJhbmNoIjoibWFpbiIsImxhYmVscyI6W119-->

Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
Co-authored-by: Micah Nagel <micah.nagel@defenseunicorns.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@CloudBeard CloudBeard CloudBeard approved these changes

@brandtkeller brandtkeller brandtkeller approved these changes

@mike-winberry mike-winberry Awaiting requested review from mike-winberry

@meganwolf0 meganwolf0 Awaiting requested review from meganwolf0

Assignees
No one assigned
Labels
open-source Contributed by non-maintainers
Projects
Lula and Friends
Status: ✅ Done
Milestone
v0.4.4
Development

Successfully merging this pull request may close these issues.
3 participants
@ogijaoh @brandtkeller @CloudBeard