# Summary

liboscal-java 2.0.0 will be a [major release](https://github.com/usnistgov/OSCAL/blob/89aa8114a66309342725369f2dc5c586090a7c7b/versioning-and-branching.md#versioning) with minor bug fixes, improvements, and backwards *non-compatible* changes to how library imports work.

# Key Take-aways for Ready Changes

This release makes updates to [metaschema-java](https://github.com/usnistgov/metaschema-java), the library that will read the OSCAL Metaschema XML files and generate reusable Java model classes and utility functions. Key takeaways are below:

1. Add library API documentation.
2. Fix bugs with serializing lists in HTML/Markdown markup.
3. Formatting output.
4. Update to OSCAL v1.0.6 models.

# Details for Ready Changes

Below is a list of all changes that will be promoted from develop to 2.0.0 release branch.

1. Updated build workflows. ([#162](https://github.com/usnistgov/liboscal-java/issues/162))
1. Update metaschema-java dep to 0.12.0 following its release. ([#160](https://github.com/usnistgov/liboscal-java/issues/160))
1. Code cleanup ([#156](https://github.com/usnistgov/liboscal-java/issues/156))
1. metaschema-java v0.11.0 update ([#150](https://github.com/usnistgov/liboscal-java/issues/150))
1. Update README.md ([#153](https://github.com/usnistgov/liboscal-java/issues/153))
1. Extend `AbstractOscalInstance` for all document types ([#129](https://github.com/usnistgov/liboscal-java/issues/129))

# Appendix

## Detailed Commit Log

**Note for NIST developers:** the output below is from executing the following command against the release branch (`main`) on a developer workstation: `git log origin/main..origin/develop --pretty=oneline --abbrev-commit`.

[2c708dd](https://github.com/usnistgov/liboscal-java/commit/2c708dd) (HEAD -> develop, origin/release-2.0, origin/develop) [maven-release-plugin] prepare for next development iteration
[b75cf8c](https://github.com/usnistgov/liboscal-java/commit/b75cf8c) (tag: v2.0.0) [maven-release-plugin] prepare release v2.0.0
[d90008f](https://github.com/usnistgov/liboscal-java/commit/d90008f) Updated build workflows. ([#162](https://github.com/usnistgov/liboscal-java/issues/162))
[ba3a222](https://github.com/usnistgov/liboscal-java/commit/ba3a222) Update metaschema-java dep to 0.12.0 following its release. (#160)
[1e62f84](https://github.com/usnistgov/liboscal-java/commit/1e62f84) Code cleanup (#156)
[c3958e9](https://github.com/usnistgov/liboscal-java/commit/c3958e9) Bump github/codeql-action from 2.20.2 to 2.20.3 (#155)
[688ab8b](https://github.com/usnistgov/liboscal-java/commit/688ab8b) Bump major version after #150 merged
[64ecdd7](https://github.com/usnistgov/liboscal-java/commit/64ecdd7) Bump actions/checkout from 3.5.2 to 3.5.3 (#146)
[ab92ce5](https://github.com/usnistgov/liboscal-java/commit/ab92ce5) Bump github/codeql-action from 2.3.6 to 2.20.2 (#152)
[19ee8eb](https://github.com/usnistgov/liboscal-java/commit/19ee8eb) Bump Saxon-HE from 12.2 to 12.3 (#154)
[4cd4a8b](https://github.com/usnistgov/liboscal-java/commit/4cd4a8b) metaschema-java v0.11.0 update (#150)
[ef83896](https://github.com/usnistgov/liboscal-java/commit/ef83896) Update README.md (#153)
[81e184f](https://github.com/usnistgov/liboscal-java/commit/81e184f) Bump Saxon-HE from 12.1 to 12.2 (#139)
[b20e995](https://github.com/usnistgov/liboscal-java/commit/b20e995) Bump git-commit-id-maven-plugin from 5.0.0 to 6.0.0 (#142)
[763dcf8](https://github.com/usnistgov/liboscal-java/commit/763dcf8) Bump github/codeql-action from 2.2.12 to 2.3.6 (#145)
[13e7548](https://github.com/usnistgov/liboscal-java/commit/13e7548) Bump github/codeql-action from 2.2.4 to 2.2.12 (#134)
[ce5de33](https://github.com/usnistgov/liboscal-java/commit/ce5de33) Bump actions/checkout from 3.3.0 to 3.5.2 (#135)
[8151a46](https://github.com/usnistgov/liboscal-java/commit/8151a46) Bump actions/setup-java from 3.10.0 to 3.11.0 (#128)
[3c5b97f](https://github.com/usnistgov/liboscal-java/commit/3c5b97f) Bump Saxon-HE from 12.0 to 12.1 (#124)
[4e6551c](https://github.com/usnistgov/liboscal-java/commit/4e6551c) Extend `AbstractOscalInstance` for all document types (#129)
[1eba4f5](https://github.com/usnistgov/liboscal-java/commit/1eba4f5) Bump dependency.log4j2.version from 2.19.0 to 2.20.0 (#118)
[dcf03ff](https://github.com/usnistgov/liboscal-java/commit/dcf03ff) Bump Saxon-HE from 11.4 to 12.0 (#112)
[f1453ac](https://github.com/usnistgov/liboscal-java/commit/f1453ac) Bump actions/setup-java from 3.9.0 to 3.10.0 (#114)
[a61a136](https://github.com/usnistgov/liboscal-java/commit/a61a136) Bump github/codeql-action from 2.2.1 to 2.2.4 (#117)
[e5fa1bb](https://github.com/usnistgov/liboscal-java/commit/e5fa1bb) [maven-release-plugin] prepare for next development iteration