coderabbitai[bot]
commented
3 months ago Walkthrough
The recent modifications enhance the release process by integrating documentation generation and version updates for various schemas. The changes facilitate automatic documentation builds during releases and update all relevant schemas from version 3 to version 4 of the Axone ontology, ensuring consistency and alignment with the latest specifications.
Changes
| File Path | Change Summary |
|---|---|
.releaserc.yml |
Updated to include prepareCmd: make docs for documentation generation and added docs/schemas/*.md to assets. |
docs/schemas/*.md (multiple files) |
Updated all schemas from version 3 to version 4, modifying namespace URLs and IRIs for consistency. |
Sequence Diagram(s)
sequenceDiagram
participant Developer
participant CI/CD
participant Documentation
participant Git
Developer->>CI/CD: Trigger Release
CI/CD->>Documentation: Run `make docs`
Documentation-->>CI/CD: Generate Documentation
CI/CD->>Git: Commit Changes
Git-->>CI/CD: Changes Committed
CI/CD->>Developer: Release CompletePoem
🐇 In burrows deep, we hop and play,
With docs and schemas, bright as day.
From version three to four we leap,
In fields of code, our knowledge keeps!
Let’s cheer for changes, big and small,
For in this dance, we’ll stand up tall! 🌼
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?
Add the documentation generation as part of the release workflow in order to keep it updated with the new version, especially in case of major version increment.
The documentation was out of date due to the latest major release.
Summary by CodeRabbit