dbt-labs / dbt-labs/actions

[CT-2345] Automate changing changelog kinds

Open
#89 1 comment 0 reactions 0 assignees View on GitHub
tech_debt
Dominant language
Python
Stars
16
Forks
7
Avg merge
2d 19h
Merged PRs (30d)
2

Description

We would like to use special `kinds` for projects to communicate the drive behind certain changes.

Sometimes the name of the project might change mid-project so we need to ability to update the `kind` and all associated changelog yamls automatically. Ideally this could be done across adapters at the same time - possibly allow an option to run for a single repo or across all repos.

Open Questions:
- How should `dbt-docs` be handled? Should it also get this special `kind` or just continue to function with the `Docs` `kind` and we have a standard to add `[project name]` in front of the change? `dbt-docs` changelogs havve a decent amount of special processing because they point to a different repo. Not a blocker, just a fact.

- Should already released betas get the `kind` updated in the markdown file? The associated yaml files should definitely get updated so that when the final release gets rolled up they categorized correctly. If we do change those markdown files, should we also change the release notes in GitHub?

Contributor guide

Open the contributing guide

Research direction

The issue names no files, tests, or entry points. Start by mapping the existing adapter changelog processing, then resolve how project-wide versus single-repository updates, dbt-docs, released betas, and GitHub release notes should behave; done means the chosen kind is updated consistently in the relevant changelog artifacts.

Written by the indexing model from the issue text.

Assessment

Tech stack
github-actions, python
Domain
devops, release
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.