diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100644 index 0000000..601ab42 --- /dev/null +++ b/CHANGELOG.md @@ -0,0 +1,85 @@ +# Changelog + +## Development Build: v1.3.0-rc4+dev20 +- Remove unnecessary parentheses around return values. +- See + +## Development Build: v1.3.0-rc4+dev16 +- Update Copyright Headers +- Standardize version.h +- See and + +## Development Build: v1.3.0-rc4+dev9 +- Apply header guard standard +- Remove explicit filename doxygen comments +- See + +## Development Build: v1.3.0-rc4+dev3 +- Update baseline to cFS-Caelum-rc4: v1.3.0-rc4 +- See + +## Development Build: v1.2.0-rc1+dev38 +- Implement Coding Standard in CodeQL workflow +- See and + +## Development Build: v1.2.0-rc1+dev34 +- Replace direct ref to ArgPtr with `UT_Hook_GetArgValueByName` macro. Reading the pointer directly is not advised. +- See and + +## Development Build: v1.2.0-rc1+dev30 +- Replace <> with " for local includes +- Adds CONTRIBUTING.md that links to the main cFS contributing guide. +- See + +## Development Build: v1.2.0-rc1+dev24 +- Simplify build to use wrappers and interface libs +- Add Testing Tools to the Security Policy +- See + +## Development Build: v1.2.0-rc1+dev10 +- Rename `UT_SetForceFail` to `UT_SetDefaultReturnValue` since some functions that retain more than 1 value are not necessarily failing +- See + +## Development Build: v1.2.0-rc1+dev8 +- No behavior changes. All identifiers now use the prefix `SAMPLE_LIB_`. Changes the name of the init function from SAMPLE_LibInit to SAMPLE_LIB_Init which affects the CFE startup script. +- Set REVISION to "99" to indicate development version status +- See + +## Development Build: v1.2.0-rc1+dev3 +- Installs unit test to target directory. +- See + +## Development Build: 1.1.0+dev27 +- Install unit test as part of cmake recipe. Sample lib test runner now shows up in expected install directory +- Add build number and baseline to version reporting +- See + +## Development Build: 1.1.4 +- Apply code style +- See + +## Development Build: 1.1.3 +- Coverage data `make lcov` includes the sample_lib code +- See + +## Development Build: 1.1.2 +- Added coverage test and a stub library to facilitate unit test +- See + +## Development Build: 1.1.1 +- See + +## ***OFFICIAL RELEASE: 1.1.0 - Aquila*** +- Released as part of cFE 6.7.0, Apache 2.0 +- See + +## ***OFFICIAL RELEASE: 1.0.0a*** +- Released as part of cFE 6.6.0a, Apache 2.0 + +## Known issues +As a lab library, extensive testing is not performed prior to release and only minimal functionality is included. + +## Getting Help +For best results, submit issues:questions or issues:help wanted requests at https://github.com/nasa/cFS. + +Official cFS page: http://cfs.gsfc.nasa.gov diff --git a/README.md b/README.md index 408b4ce..59376a3 100644 --- a/README.md +++ b/README.md @@ -9,100 +9,6 @@ This sample library is a non-flight example library implementation for the cFS B sample_lib implements SAMPLE_Function, as an example for how to build and link a library in cFS. -## Version History - -### Development Build: v1.3.0-rc4+dev20 -- Remove unnecessary parentheses around return values. -- See - -### Development Build: v1.3.0-rc4+dev16 - -- Update Copyright Headers -- Standardize version.h -- See and -### Development Build: v1.3.0-rc4+dev9 - -- Apply header guard standard -- Remove explicit filename doxygen comments -- See - -### Development Build: v1.3.0-rc4+dev3 - -- Update baseline to cFS-Caelum-rc4: v1.3.0-rc4 -- See - -### Development Build: v1.2.0-rc1+dev38 - -- Implement Coding Standard in CodeQL workflow -- See and - -### Development Build: v1.2.0-rc1+dev34 - -- Replace direct ref to ArgPtr with `UT_Hook_GetArgValueByName` macro. Reading the pointer directly is not advised. -- See and - -### Development Build: v1.2.0-rc1+dev30 - -- Replace <> with " for local includes -- Adds CONTRIBUTING.md that links to the main cFS contributing guide. -- See - -### Development Build: v1.2.0-rc1+dev24 - -- Simplify build to use wrappers and interface libs -- Add Testing Tools to the Security Policy -- See - -### Development Build: v1.2.0-rc1+dev10 - -- Rename `UT_SetForceFail` to `UT_SetDefaultReturnValue` since some functions that retain more than 1 value are not necessarily failing -- See - -### Development Build: v1.2.0-rc1+dev8 - -- No behavior changes. All identifiers now use the prefix `SAMPLE_LIB_`. Changes the name of the init function from SAMPLE_LibInit to SAMPLE_LIB_Init which affects the CFE startup script. -- Set REVISION to "99" to indicate development version status -- See - -### Development Build: v1.2.0-rc1+dev3 - -- Installs unit test to target directory. -- See - -### Development Build: 1.1.0+dev27 - -- Install unit test as part of cmake recipe. Sample lib test runner now shows up in expected install directory -- Add build number and baseline to version reporting -- See - -### Development Build: 1.1.4 - -- Apply code style -- See - -### Development Build: 1.1.3 - -- Coverage data `make lcov` includes the sample_lib code -- See - -### Development Build: 1.1.2 - -- Added coverage test and a stub library to facilitate unit test -- See - -### Development Build: 1.1.1 - -- See - -### ***OFFICIAL RELEASE: 1.1.0 - Aquila*** - -- Released as part of cFE 6.7.0, Apache 2.0 -- See - -### ***OFFICIAL RELEASE: 1.0.0a*** - -- Released as part of cFE 6.6.0a, Apache 2.0 - ## Known issues As a lab library, extensive testing is not performed prior to release and only minimal functionality is included.