diff --git a/CHANGELOG.md b/CHANGELOG.md index 8466004..854309c 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -9,13 +9,10 @@ - **readme**: Non critical issue, but still an issue ([`cb06128`](https://github.com/muszyn/release-testing/commit/cb061287cd96aa8d841f0066a6c4f2992a82a160)) - ## v1.1.2 (2025-06-07) - ## v1.1.1 (2025-06-07) - ## v1.1.0 (2025-06-07) ### Features @@ -23,7 +20,6 @@ - **apis**: Really big update ([`ce62257`](https://github.com/muszyn/release-testing/commit/ce62257c51dace3835683c0ba5fa62cf119be0b9)) - ## v1.0.0 (2025-06-07) - Initial Release diff --git a/README.md b/README.md index 36597a2..1157677 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,30 @@ # Python Semantic Release Basically the command makes a commit, and tags it as a release. -The changelog looks fine, just has commits from what I can tell right now. +The changelog looks fine, just has commits from what I can tell right now. Also has messages so works for me. Seems to have an API integration with bb and gh so should be able to work with that easily. Would like to implement this in sp6 for ingestion service. + +I am thinking how to have this in our CI pipeline. + +So in the concept of SemVer we have two public apis. + +1. SNS Topic +2. KinesisFirehose + +Majors - changes that are NOT back compat. +Minor - backwards compatible feature +Patch - backwards compatible fixes + +So unless we make breaking changes to the output of the service ie. change the structure of the RobotMessage we are only using minor/patch. + +Minors -> This will probably be mostly schema updates/ adding schema types +Patch -> This will be any bug fixes/ performance changes + +The plan for a major change is to deploy another ingestion stack, release a migration guide, and push for everyone to be on it in `n` weeks. + +The plan for a minor change is to release the notes. + +The plan for a patch is the same as a minor.