Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Automate and optimize release note creation #4522

Draft
wants to merge 29 commits into
base: stable
Choose a base branch
from

Conversation

lykinsbd
Copy link
Contributor

@lykinsbd lykinsbd commented Oct 2, 2024

Closes Issue #4519

@github-actions github-actions bot added the group/ci Issue related to the CI pipeline label Oct 2, 2024
@github-actions github-actions bot added type/documentation Improvements or additions to documentation group/backend Issue related to the backend (API Server, Git Agent) group/frontend Issue related to the frontend (React) labels Oct 7, 2024
@github-actions github-actions bot removed type/documentation Improvements or additions to documentation group/backend Issue related to the backend (API Server, Git Agent) group/frontend Issue related to the frontend (React) labels Oct 7, 2024
@lykinsbd
Copy link
Contributor Author

lykinsbd commented Oct 7, 2024

WIP progressing:

 - [release] Lint release files with markdownlint-cli2
markdownlint-cli2 v0.14.0 (markdownlint v0.35.0)
Finding: changelog/*.md !changelog/towncrier_template.md CHANGELOG.md docs/docs/release-notes/infrahub/*.{md,mdx}
Linting: 23 file(s)
Summary: 0 error(s)
 - [release] Lint release files with vale
✔ 0 errors, 0 warnings and 0 suggestions in 23 files.
 - [release] Verify Towncrier render possible
Loading template...
Finding news fragments...
Rendering news fragments...
Draft only -- nothing has been written.
What is seen below is what would be written.

## [Infrahub - v0.16.2](https://github.com/opsmill/infrahub/tree/infrahub-v0.16.2) - 2024-10-07


### Added

- Adding `invoke` tasks to assist with release process. ([#4519](https://github.com/opsmill/infrahub/issues/4519))
- Added custom Towncrier template to remove extra space after new Changelog entries.

### Fixed

- Save a diff in smaller pieces instead of all at once to prevent out-of-memory error. ([#4511](https://github.com/opsmill/infrahub/issues/4511))
- Editing old `CHANGELOG.md` entries to use uniform formatting from new Towncrier template.
- Fixes exception handling section in the Python SDK batch guide.

@github-actions github-actions bot added the type/documentation Improvements or additions to documentation label Nov 8, 2024
@github-actions github-actions bot removed the type/documentation Improvements or additions to documentation label Nov 13, 2024
@github-actions github-actions bot added the type/documentation Improvements or additions to documentation label Nov 13, 2024
Copy link

codspeed-hq bot commented Nov 14, 2024

CodSpeed Performance Report

Merging #4522 will not alter performance

Comparing bdl-20241002-release_tweaks (d41676a) with stable (68d105f)

Summary

✅ 10 untouched benchmarks

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
group/ci Issue related to the CI pipeline type/documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant