Automate changelog #4743

emmyoop · 2022-02-17T19:33:22Z

resolves #4652

Description

This adds changie to dbt-core!

New directory .changes where the actual changelog files (yaml or md) will live. This directory also contains a header file that will apply as a header to the entire CHANGELOG.md
.changie.yaml defines what data is in a changelog entry as well as the format it will output into markdown.
Added relevant updates to CONTRIBUTING
New GitHub action to block merging if no new changelog file has been generated. The best this can do is check the PR has a new .yaml in the appropriate directory as the file names are generated dynamically. It also provides an override where the Skip Changelog label on a PR would allow the check to pass without the file.

Pending

Before merging into main, make sure the markdown file in /.changes is up to date for the most recent version of the master changelog.
GHA to generate and merge in the changelog. For the first run it may be useful to do it manually just to make sure everything gets synced up with the right dates, etc in the "legacy" CHANGELOG. After the first time it should all be automated without issue. [CT-289] Automate Changelog Generation on Release #4789

Checklist

I have signed the CLA
I have run this code in development and it appears to resolve the stated issue
This PR includes tests, or tests are not required/relevant for this PR
I have updated the CHANGELOG.md and added information about my change

.changes/header.tpl.md

emmyoop · 2022-02-22T15:28:25Z

New changie release for the pre-release request. Need to look into how it works but will hopefully replace the manual script I wrote!

Edit: This release 100% replaced my last custom script!

.github/workflows/changelog-check.yml

github-actions · 2022-02-24T16:38:04Z

👋 Thanks for adding a changelog entry!

github-actions · 2022-02-24T17:07:17Z

👋 Thanks for adding a changelog entry! Delete this before the end. It's really just here to test output.

github-actions · 2022-02-24T17:19:57Z

👋 Thanks for adding a changelog entry! Delete this before the end. It's really just here to test output.

iknox-fa

This looks great! I'm on the fence about this, but should we include changie as part of the Makefile? I opted to add it for pre-commit, but this feels somewhere inbetween a developer's choice thing and a required thing.

gshank

I am sooooo looking forward to this!

.changes/README.md

nathaniel-may

I didn't take a close enough look at the action and the templates yet but I wanted to leave the note about make dev.

nathaniel-may · 2022-02-25T16:47:24Z

.changes/README.md

+### Workflow
+
+#### Daily workflow
+Each code change gets a changlog file by running `changie new` and following the prompts.  This ensures correct file format and file name.


to run changie new should we add it to be installed with make dev?

nathaniel-may · 2022-02-25T16:49:35Z

CONTRIBUTING.md

+
+We use [changie](https://changie.dev) to generate `CHANGELOG` entries.  Do not edit the `CHANGELOG.md` directly.  Your modifications will be lost.
+
+Follow the steps to [install `changie`](https://changie.dev/guide/installation/) for your system.


if we use make dev this instruction could change to reflect that.

To close the loop from a slack conversation, we can't add changie to make dev as it isn't available through pip. If this becomes an issue we'll explore some alternative ways to make changie available.

ChenyuLInx

This is great!!! One question, what will happen to the original changelog?

emmyoop · 2022-02-25T16:56:49Z

@ChenyuLInx The original changelog is saved as a markdown file in /.changes here. When ready to merge this in I was going to update the name to whatever release is the most recent.

Every time changie merge is run it stitches together all the markdown files in /.changes to generate the CHANGELOG.

leahwicz · 2022-03-01T14:05:03Z

.changie.yaml

+footerFormat: |
+  Contributors:
+  {{- $contributorDict := dict }}
+  {{- $core_team := list "emmyoop" "nathaniel-may" "gshank" "leahwicz" "ChenyuLInx" "stu-k" "iknox-fa" "VersusFacit" "McKnight-42" "jtcohen6" }}


This can be a good first issue for new hires to just add themselves to this list

Is there a single running list of things like this somewhere?

I don't like that this is hardcoded but I'm not seeing a way around it at the moment.

I'm not sure if we can use GitHub's team concept to get this list. We have the Core team which contains all the handles. For this PR, I'm ok with the hardcoded list but then thinking about improvements after that

The Github API looks like it has a way to do it via the returned "login" field, but it would involve mapping over the returned list. I agree it would be good for a subsequent improvement.

.github/workflows/changelog-check.yml

.changes/README.md

leahwicz

LGTM!

This reverts commit 490bda8.

* initial setup to use changie * added `dbt-core` to version line * fix formatting * rename to be more accurate * remove extra file * add stug for contributing section * updated docs for contributing and changelog * first pass at changelog check * Fix workflow name * comment on handling failure * add automatic contributors section via footer * removed unused initialization * add script to automate entire changelog creation and handle prereleases * stub out README * add changelog entry! * no longer need to add contributors ourselves * fixed formatted and excluded core team * fix typo and collapse if statement * updated to reflect automatic pre-release handling Removed custom script in favor of built in pre-release functionality in new version of changie. * update contributing doc * pass at GHA * fix path * all changed files * more GHA work * continued GHA work * try another approach * testing * adding comment via GHA * added uses for GHA * more debugging * fixed formatting * another comment attempt * remove read permission * add label check * fix quotes * checking label logic * test forcing failure * remove extra script tag * removed logic for having changelog * Revert "removed logic for having changelog" This reverts commit 490bda8. * remove unused workflow section * update header and readme * update with current version of changelog * add step failure for missing changelog file * fix typos and formatting * small tweaks per feedback * Update so changelog end up onlywith current version, not past * update changelog to recent contents * added the rest of our releases to previous release list * clarifying the readme * updated to reflect current changelog state * updated so only 1.1 changes are on main # Conflicts: # CHANGELOG.md

* Automate changelog (#4743) * initial setup to use changie * added `dbt-core` to version line * fix formatting * rename to be more accurate * remove extra file * add stug for contributing section * updated docs for contributing and changelog * first pass at changelog check * Fix workflow name * comment on handling failure * add automatic contributors section via footer * removed unused initialization * add script to automate entire changelog creation and handle prereleases * stub out README * add changelog entry! * no longer need to add contributors ourselves * fixed formatted and excluded core team * fix typo and collapse if statement * updated to reflect automatic pre-release handling Removed custom script in favor of built in pre-release functionality in new version of changie. * update contributing doc * pass at GHA * fix path * all changed files * more GHA work * continued GHA work * try another approach * testing * adding comment via GHA * added uses for GHA * more debugging * fixed formatting * another comment attempt * remove read permission * add label check * fix quotes * checking label logic * test forcing failure * remove extra script tag * removed logic for having changelog * Revert "removed logic for having changelog" This reverts commit 490bda8. * remove unused workflow section * update header and readme * update with current version of changelog * add step failure for missing changelog file * fix typos and formatting * small tweaks per feedback * Update so changelog end up onlywith current version, not past * update changelog to recent contents * added the rest of our releases to previous release list * clarifying the readme * updated to reflect current changelog state * updated so only 1.1 changes are on main # Conflicts: # CHANGELOG.md * updated to reflect current state of 1.0.latest * convert backports to changie entries

cla-bot bot added the cla:yes label Feb 17, 2022

emmyoop commented Feb 18, 2022

View reviewed changes

.changes/header.tpl.md Outdated Show resolved Hide resolved

emmyoop commented Feb 23, 2022

View reviewed changes

.github/workflows/changelog-check.yml Outdated Show resolved Hide resolved

emmyoop marked this pull request as ready for review February 24, 2022 21:51

emmyoop requested a review from a team as a code owner February 24, 2022 21:51

emmyoop requested review from jtcohen6 and leahwicz February 24, 2022 21:56

iknox-fa reviewed Feb 24, 2022

View reviewed changes

emmyoop requested review from stu-k, VersusFacit, nathaniel-may, ChenyuLInx, gshank and McKnight-42 February 24, 2022 22:39

gshank approved these changes Feb 24, 2022

View reviewed changes

.changes/README.md Outdated Show resolved Hide resolved

.changes/README.md Outdated Show resolved Hide resolved

iknox-fa approved these changes Feb 24, 2022

View reviewed changes

McKnight-42 approved these changes Feb 25, 2022

View reviewed changes

nathaniel-may reviewed Feb 25, 2022

View reviewed changes

ChenyuLInx approved these changes Feb 25, 2022

View reviewed changes

leahwicz reviewed Mar 1, 2022

View reviewed changes

.github/workflows/changelog-check.yml Outdated Show resolved Hide resolved

leahwicz reviewed Mar 1, 2022

View reviewed changes

.github/workflows/changelog-check.yml Show resolved Hide resolved

leahwicz reviewed Mar 1, 2022

View reviewed changes

.github/workflows/changelog-check.yml Outdated Show resolved Hide resolved

leahwicz reviewed Mar 1, 2022

View reviewed changes

.changes/README.md Outdated Show resolved Hide resolved

leahwicz approved these changes Mar 2, 2022

View reviewed changes

emmyoop added 23 commits March 7, 2022 19:45

added uses for GHA

c27c618

more debugging

b1ab760

fixed formatting

7b6d97c

another comment attempt

a843c30

remove read permission

16edef0

add label check

208908a

fix quotes

6c7b7bc

checking label logic

d45b6bb

test forcing failure

369d3a6

remove extra script tag

c13daa5

removed logic for having changelog

e816cb3

Revert "removed logic for having changelog"

5376342

This reverts commit 490bda8.

remove unused workflow section

7960c88

update header and readme

649b864

update with current version of changelog

f7ae97e

add step failure for missing changelog file

0787968

fix typos and formatting

f96fb25

small tweaks per feedback

1d0146d

Update so changelog end up onlywith current version, not past

03ed50e

update changelog to recent contents

80778ac

added the rest of our releases to previous release list

0bfdca0

clarifying the readme

f203f9c

updated to reflect current changelog state

1f39de2

emmyoop force-pushed the er/ct-115-automate-changelog branch from 5660596 to 1f39de2 Compare March 8, 2022 01:48

updated so only 1.1 changes are on main

38903a3

emmyoop merged commit 9a0abc1 into main Mar 8, 2022

emmyoop deleted the er/ct-115-automate-changelog branch March 8, 2022 02:12

emmyoop mentioned this pull request Mar 8, 2022

[Backport] automate changelog #4840

Merged

4 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Automate changelog #4743

Automate changelog #4743

emmyoop commented Feb 17, 2022 •

edited

emmyoop commented Feb 22, 2022 •

edited

github-actions bot commented Feb 24, 2022

github-actions bot commented Feb 24, 2022

github-actions bot commented Feb 24, 2022

iknox-fa left a comment

gshank left a comment

nathaniel-may left a comment

nathaniel-may Feb 25, 2022

nathaniel-may Feb 25, 2022

emmyoop Feb 25, 2022

ChenyuLInx left a comment

emmyoop commented Feb 25, 2022 •

edited

leahwicz Mar 1, 2022

emmyoop Mar 1, 2022

leahwicz Mar 2, 2022

nathaniel-may Mar 7, 2022

leahwicz left a comment


		We use [changie](https://changie.dev) to generate `CHANGELOG` entries. Do not edit the `CHANGELOG.md` directly. Your modifications will be lost.

		Follow the steps to [install `changie`](https://changie.dev/guide/installation/) for your system.

Automate changelog #4743

Automate changelog #4743

Conversation

emmyoop commented Feb 17, 2022 • edited

Description

Pending

Checklist

emmyoop commented Feb 22, 2022 • edited

github-actions bot commented Feb 24, 2022

github-actions bot commented Feb 24, 2022

github-actions bot commented Feb 24, 2022

iknox-fa left a comment

Choose a reason for hiding this comment

gshank left a comment

Choose a reason for hiding this comment

nathaniel-may left a comment

Choose a reason for hiding this comment

nathaniel-may Feb 25, 2022

Choose a reason for hiding this comment

nathaniel-may Feb 25, 2022

Choose a reason for hiding this comment

emmyoop Feb 25, 2022

Choose a reason for hiding this comment

ChenyuLInx left a comment

Choose a reason for hiding this comment

emmyoop commented Feb 25, 2022 • edited

leahwicz Mar 1, 2022

Choose a reason for hiding this comment

emmyoop Mar 1, 2022

Choose a reason for hiding this comment

leahwicz Mar 2, 2022

Choose a reason for hiding this comment

nathaniel-may Mar 7, 2022

Choose a reason for hiding this comment

leahwicz left a comment

Choose a reason for hiding this comment

emmyoop commented Feb 17, 2022 •

edited

emmyoop commented Feb 22, 2022 •

edited

emmyoop commented Feb 25, 2022 •

edited