Skip to content

Commit

Permalink
pre-release cleanup, update changelog and fix readme typos
Browse files Browse the repository at this point in the history
Signed-off-by: Steve Arnold <sarnold@vctlabs.com>
  • Loading branch information
sarnold committed May 15, 2024
1 parent dd37d26 commit 5645bc1
Show file tree
Hide file tree
Showing 2 changed files with 78 additions and 38 deletions.
112 changes: 76 additions & 36 deletions CHANGELOG.rst
Original file line number Diff line number Diff line change
@@ -1,6 +1,82 @@
Changelog
=========


0.4.0 (2024-05-15)
------------------

New
~~~
- Add ID set analysis to oscal module, update tests and default cfg.
[Steve Arnold]
- Add analysis script using SSG nist control files. [Steve Arnold]

* update project files for new dependencies
- Add file reader to handle csv, json, yaml, and simple text files.
[Steve Arnold]

* for each type, parse into a list of objects and return the list
* where simple text files are something like the control IDs
in tests/data

Changes
~~~~~~~
- Add more control status reporting, update oscal yaml config. [Steve
Arnold]
- Cleanup deps and docstrings, add set compare to demo script. [Steve
Arnold]
- Still more readme cleanup. [Steve Arnold]
- Commit initail name changes; package, imports, readme. [Steve Arnold]
- Make sure yagrep uses new output func, cleanup readme. [Steve Arnold]
- Bump tox workflow deps and cleanup/improve readme. [Steve Arnold]
- Bump all workflow action versions. [Steve Arnold]
- Add another text_file_reader consumer and cleanup some lint. [Steve
Arnold]

Fixes
~~~~~
- Account for longer ID strings, update changelog and repolite cfgs.
[Steve Arnold]

* update tests and older analysis script
* bump requirements-sync.txt for new repolite release
- Cleanup docstrings after sphinx checks. [Steve Arnold]

Other
~~~~~
- Dev: add csv file munge option, cleanup oscal files. [Steve Arnold]

* add munge file arg to pass in csv data to compare and append
a column for id set status, eg, whether ids in the input list
are present in the csv data, and then mark the new column Y/N
* short-circuit munge file arg and feed it single column of
control IDs
- Add small set of test IDs from openembedded profile. [Steve Arnold]


0.3.0 (2024-03-12)
------------------

New
~~~
- Add new console script, update reqs and packaging. [Steve Arnold]

Changes
~~~~~~~
- Cleanup new feature bits and update documentation. [Steve Arnold]

* use dpath.values for initial path search, and either dpath or
nested_lookup for extracting values
* update readme for new script, update all the usage bits
* add new tests and update existing tests
* expand and cleanup tox file
- Add new feature tests, update existing tests. [Steve Arnold]

Fixes
~~~~~
- Re-order yasort arg handling, update analyze script. [Steve Arnold]


0.2.2 (2023-09-05)
------------------

Expand All @@ -20,15 +96,6 @@ Fixes
~~~~~
- Clean up docstrings in utils. [Stephen L Arnold]

Other
~~~~~
- Merge pull request #11 from sarnold/docs-cleanup. [Steve Arnold]

Docs cleanup
- Merge pull request #10 from sarnold/comments. [Steve Arnold]

Refactor libs, add tests, preserve comments in sorted list


0.2.1 (2023-07-16)
------------------
Expand All @@ -45,12 +112,6 @@ Fixes
- Ci: update artifact conditional. add inspection step. [Stephen L
Arnold]

Other
~~~~~
- Merge pull request #9 from sarnold/sort-opts. [Steve Arnold]

wire up sorting opts


0.2.0 (2023-07-15)
------------------
Expand Down Expand Up @@ -87,18 +148,9 @@ Fixes

Other
~~~~~
- Merge pull request #8 from sarnold/new-refactor. [Steve Arnold]

code migration and cleanup
- Adjust importlib version cutoff in reqs. [Stephen L Arnold]
- Move some shared code to separate module, update pre-commit cfg.
[Stephen L Arnold]
- Merge pull request #6 from sarnold/cfg-update. [Steve Arnold]

add config options and munch type stubs
- Merge pull request #5 from sarnold/option-parse. [Steve Arnold]

refactor arg handling


0.1.0 (2022-06-22)
Expand Down Expand Up @@ -127,25 +179,13 @@ Fixes

Other
~~~~~
- Merge pull request #4 from sarnold/pre-commit. [Steve Arnold]

readme and pre-commit updates
- Merge pull request #3 from sarnold/doc-updates. [Steve Arnold]

Add sphinx doc build/workflow
- Add docs workflow, fix broken doc link, update ci workflow. [Stephen L
Arnold]
- Merge pull request #2 from sarnold/script-ref. [Steve Arnold]

Script refactor plus packaging and workflows
- Cleanup metadata/packaging and workflow files. [Stephen L Arnold]
- Add more CI workflows for wheels, pylint, release. [Stephen L Arnold]


0.0.0 (2022-06-19)
------------------
- Merge pull request #1 from sarnold/cleanup-poc. [Steve Arnold]

Cleanup poc
- Initial commit with test scripts and tox driver. [Stephen L Arnold]
- Initial commit. [Steve Arnold]
4 changes: 2 additions & 2 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -399,8 +399,8 @@ something like::

then install it into the repo you just cloned::

$ git clone https://github.com/sarnold/yaml_tools
$ cd yaml_tools/
$ git clone https://github.com/sarnold/yaml-tools
$ cd yaml-tools/
$ pre-commit install

It's usually a good idea to update the hooks to the latest version::
Expand Down

0 comments on commit 5645bc1

Please sign in to comment.