v0.4.0

Breaking Changes 💥

• #57 Prepare action inputs for several high level features and regimes in #72
  • New Action Input logic affecting the current way of use.
  • New project folder structure.
  • New logic accepting more than just one mining regime.
  • New way of writing the documentation via multiple README.md.

New Features 🎉

• #54 Introduce NoTopic chapter in #69
  • Introduced No Topic chapter, when issue does not have defined a Topic label.
• #70 Simplify GH Workflows using new GH Actions in #71
  • Switched to use new GH action. Simplified workflow files.

Bugfixes 🛠

• PR: #76 Feature/75 fixing the overall bugs based on a observation
  • Updating documentation to the current logic.

Full Changelog

v0.3.0...v0.4.0

v0.3.0

New Features 🎉

• #34 Introduce Unit Tests and Code Coverage in #67
  • Implemented unit tests using Pytest for generator.py and main.py (project code-cov at (96 %).
• #52 Introduce Topics in #63
  • New user feature, that provides an option of grouping issues by Topics.
• #54 Introduce NoTopic chapter in #69
  • Introduced No Topic chapter, when issue does not have defined a Topic label.
• #60 _Index page to be compatible with html projects _
  • Index page is compatible with html projects (mdoc viewer).
• #65 Do Not Persist Credentials - Workflows in #66
  • Disabled saving of credential in all checkout actions.

Full Changelog

v0.2.0...v0.3.0

v0.2.0

New Features 🎉

• PR: #43 Unit tests using Pytest for action_inputs.py.
• #50 Improve generated overview table on index page to be compatible with mdoc project in #60
  • Index page is compatible with html projects (mdoc viewer).
• #51 Update expected structure of generate output when cps-mdoc in #60
  • Index page is compatible with html projects (mdoc viewer).
• PR: #58 Unit tests using Pytest for github_projects.py.
• #59 Apply brainstorming vision in #61
  • Adding more theory details about Documentation issues
  • Described vision of future development.

Full Changelog

v0.1.0...v0.2.0

v0.1.0

New Features 🎉

• #17 Action migration to composite in #18
  • Action migrated to composite type.
  • Renamed main control script.
• #21 Replace github_integration by the usage of decorators approach in #24
  • Introduced decorators.
  • Removed usage of local overload of GitHub library and replaced it with decorator usage.
• #23 Introduce code format check and linter check in #29
  • Pylint suggestions implemented in the project.
• PR: #26 _Implementing logging best practices in the project
  • Logging best practices implemented into the project.
  • Dynamic GitHub logging implemented.
• #31 Release PoC - fix workflow before Release in #49
  • Updated GH workflow files for Release draft generation and PR Release Notes check.
• PR: #39 Feature/6 support more projects for one issue
  • Logic for issue having data from several projects added.
• PR: #40 Feature/37 add control & logic for repo sub directories
  • Structured output optional feature implemented.

Bugfixes 🛠

• PR: #33 Bug Fix Running CI Integration Test
  • Bug fix for successful integration CI test.
• PR: #38 Bugfix/35 missing no issue data detection in project issue loading logic
  • Debug log messages updated to reflect code changes and the reality of data flow.
  • Check for empty issue data added into POC.

Full Changelog

https://github.com/AbsaOSS/living-doc-generator/commits/v0.1.0.