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

task: streamline release note creation #4519

Open
7 tasks
lykinsbd opened this issue Oct 2, 2024 · 0 comments
Open
7 tasks

task: streamline release note creation #4519

lykinsbd opened this issue Oct 2, 2024 · 0 comments
Assignees
Labels
type/task Body of work related to an epic

Comments

@lykinsbd
Copy link
Contributor

lykinsbd commented Oct 2, 2024

Component

Documentation & Examples

Task Description

As part of the ongoing evolution of Infrahub's release process, Towncrier is generating the CHANGELOG.md file. However, many manual steps remain to process that information and generate the required output for the documentation website and the GitHub release notes.

As a maintainer of Infrahub, I would like to be able to call on a single Invoke task to:

  • Bump the project version (ala, poetry version <patch/minor/major>)
  • Install the new project version in the dev environment (to allow Towncrier to see the correct version for release)
  • Read and validate the Towncrier "Newsfragment" files with both towncrier build --draft/towncrier check and invoke docs.lint (MDlint and Vale)
  • Copy the textual output from towncrier build --draft and place it into:
    • A release note file in the documentation (creating one for this release if it does not already exist)
    • A draft GitHub release (creating one for this release if it does not already exist)
  • Generate CHANGELOG.md updates and cleanup Newsfragments with towncrier build
@lykinsbd lykinsbd added the type/task Body of work related to an epic label Oct 2, 2024
@lykinsbd lykinsbd self-assigned this Oct 2, 2024
@exalate-issue-sync exalate-issue-sync bot removed this from the Infrahub - 0.16.3 milestone Oct 15, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
type/task Body of work related to an epic
Projects
None yet
Development

No branches or pull requests

1 participant