changie - convert changelogs to yaml files and make quality of life improvements (#4917)

* convert changelog to changie yaml files

* update contributor format and README instructions

* update action to rerun when labeled/unlabled

* remove synchronize from action

* remove md file replaced by the yaml

* add synchronize and comment of what's happening

* tweak formatting

.changes/1.0.99.md

@@ -1,33 +0,0 @@
-*** below changes will need to be manually merged with the changes generated by `changie batch` for 1.1.0.  Once the two are merged, this file should be deleted.  This is a one time thing because changie was introduced mid-development. ***  
-
-## dbt-core 1.1.0 (TBD)
-
-### Features
-- Added Support for Semantic Versioning ([#4644](https://github.com/dbt-labs/dbt-core/pull/4644))
-- New Dockerfile to support specific db adapters and platforms.  See docker/README.md for details ([#4495](https://github.com/dbt-labs/dbt-core/issues/4495), [#4487](https://github.com/dbt-labs/dbt-core/pull/4487))
-- Allow unique_key to take a list ([#2479](https://github.com/dbt-labs/dbt-core/issues/2479), [#4618](https://github.com/dbt-labs/dbt-core/pull/4618))
-- Add `--quiet` global flag and `print` Jinja function ([#3451](https://github.com/dbt-labs/dbt-core/issues/3451), [#4701](https://github.com/dbt-labs/dbt-core/pull/4701))
-
-### Fixes
-- User wasn't asked for permission to overwite a profile entry when running init inside an existing project ([#4375](https://github.com/dbt-labs/dbt-core/issues/4375), [#4447](https://github.com/dbt-labs/dbt-core/pull/4447))
-- Add project name validation to `dbt init` ([#4490](https://github.com/dbt-labs/dbt-core/issues/4490),[#4536](https://github.com/dbt-labs/dbt-core/pull/4536))
-- Allow override of string and numeric types for adapters. ([#4603](https://github.com/dbt-labs/dbt-core/issues/4603))
-- A change in secret environment variables won't trigger a full reparse [#4650](https://github.com/dbt-labs/dbt-core/issues/4650) [4665](https://github.com/dbt-labs/dbt-core/pull/4665)
-- Fix misspellings and typos in docstrings ([#4545](https://github.com/dbt-labs/dbt-core/pull/4545))
-
-### Under the hood
-- Testing cleanup ([#4496](https://github.com/dbt-labs/dbt-core/pull/4496), [#4509](https://github.com/dbt-labs/dbt-core/pull/4509))
-- Clean up test deprecation warnings ([#3988](https://github.com/dbt-labs/dbt-core/issue/3988), [#4556](https://github.com/dbt-labs/dbt-core/pull/4556))
-- Use mashumaro for serialization in event logging ([#4504](https://github.com/dbt-labs/dbt-core/issues/4504), [#4505](https://github.com/dbt-labs/dbt-core/pull/4505))
-- Drop support for Python 3.7.0 + 3.7.1 ([#4584](https://github.com/dbt-labs/dbt-core/issues/4584), [#4585](https://github.com/dbt-labs/dbt-core/pull/4585), [#4643](https://github.com/dbt-labs/dbt-core/pull/4643))
-- Re-format codebase (except tests) using pre-commit hooks ([#3195](https://github.com/dbt-labs/dbt-core/issues/3195), [#4697](https://github.com/dbt-labs/dbt-core/pull/4697))
-- Add deps module README ([#4686](https://github.com/dbt-labs/dbt-core/pull/4686/))
-- Initial conversion of tests to pytest ([#4690](https://github.com/dbt-labs/dbt-core/issues/4690), [#4691](https://github.com/dbt-labs/dbt-core/pull/4691))
-- Fix errors in Windows for tests/functions ([#4781](https://github.com/dbt-labs/dbt-core/issues/4781), [#4767](https://github.com/dbt-labs/dbt-core/pull/4767))
-
-Contributors:
-- [@NiallRees](https://github.com/NiallRees) ([#4447](https://github.com/dbt-labs/dbt-core/pull/4447))
-- [@alswang18](https://github.com/alswang18) ([#4644](https://github.com/dbt-labs/dbt-core/pull/4644))
-- [@emartens](https://github.com/ehmartens) ([#4701](https://github.com/dbt-labs/dbt-core/pull/4701))
-- [@mdesmet](https://github.com/mdesmet) ([#4604](https://github.com/dbt-labs/dbt-core/pull/4604))
-- [@kazanzhy](https://github.com/kazanzhy) ([#4545](https://github.com/dbt-labs/dbt-core/pull/4545))

.changes/README.md

@@ -26,6 +26,12 @@ changie batch <version>  --move-dir '<version>' --prerelease 'rc1'
 changie merge
 ```
 
+Example
+```
+changie batch 1.0.5  --move-dir '1.0.5' --prerelease 'rc1'
+changie merge
+```
+
 #### Final Release Workflow
 These commands batch up changes in `/.changes/unreleased` as well as `/.changes/<version>` to be included in this final release and delete all prereleases.  This rolls all prereleases up into a single final release.  All `yaml` files in `/unreleased` and `<version>` will be deleted at this point.
 
@@ -34,7 +40,14 @@ changie batch <version>  --include '<version>' --remove-prereleases
 changie merge
 ```
 
+Example
+```
+changie batch 1.0.5  --include '1.0.5' --remove-prereleases
+changie merge
+```
+
 ### A Note on Manual Edits & Gotchas
 - Changie generates markdown files in the `.changes` directory that are parsed together with the `changie merge` command.  Every time `changie merge` is run, it regenerates the entire file.  For this reason, any changes made directly to `CHANGELOG.md` will be overwritten on the next run of `changie merge`.
 - If changes need to be made to the `CHANGELOG.md`, make the changes to the relevant `<version>.md` file located in the `/.changes` directory.  You will then run `changie merge` to regenerate the `CHANGELOG.MD`.
 - Do not run `changie batch` again on released versions.  Our final release workflow deletes all of the yaml files associated with individual changes.  If for some reason modifications to the `CHANGELOG.md` are required after we've generated the final release `CHANGELOG.md`, the modifications need to be done manually to the `<version>.md` file in the `/.changes` directory.
+- changie can modify, create and delete files depending on the command you run.  This is expected.  Be sure to commit everything that has been modified and deleted.

.changes/unreleased/Features-20220321-135949.yaml

@@ -0,0 +1,7 @@
+kind: Features
+body: Added Support for Semantic Versioning
+time: 2022-03-21T13:59:49.725046-05:00
+custom:
+  Author: alswang18
+  Issue: "4453"
+  PR: "4644"

.changes/unreleased/Features-20220321-140046.yaml

@@ -0,0 +1,8 @@
+kind: Features
+body: New Dockerfile to support specific db adapters and platforms. See docker/README.md
+  for details
+time: 2022-03-21T14:00:46.670045-05:00
+custom:
+  Author: iknox-fa
+  Issue: "4495"
+  PR: "4487"

.changes/unreleased/Features-20220321-140139.yaml

@@ -0,0 +1,7 @@
+kind: Features
+body: Allow unique_key to take a list
+time: 2022-03-21T14:01:39.918897-05:00
+custom:
+  Author: gshank
+  Issue: "2479"
+  PR: "4618"

.changes/unreleased/Features-20220321-140306.yaml

@@ -0,0 +1,7 @@
+kind: Features
+body: "Add `--quiet` global flag and `print` Jinja function"
+time: 2022-03-21T14:03:06.565157-05:00
+custom:
+  Author: ehmartens
+  Issue: "3451"
+  PR: "4701"

.changes/unreleased/Fixes-20220321-140521.yaml

@@ -0,0 +1,7 @@
+kind: Fixes
+body: "User wasn't asked for permission to overwite a profile entry when running init inside an existing project"
+time: 2022-03-21T14:05:21.238521-05:00
+custom:
+  Author: NiallRees
+  Issue: "4375"
+  PR: "4447"

.changes/unreleased/Fixes-20220321-140720.yaml

@@ -0,0 +1,7 @@
+kind: Fixes
+body: Add project name validation to `dbt init`
+time: 2022-03-21T14:07:20.153071-05:00
+custom:
+  Author: amirkdv
+  Issue: "4490"
+  PR: "4536"

.changes/unreleased/Fixes-20220321-140833.yaml

@@ -0,0 +1,7 @@
+kind: Fixes
+body: Allow override of string and numeric types for adapters.
+time: 2022-03-21T14:08:33.384372-05:00
+custom:
+  Author: mdesmet
+  Issue: "4603"
+  PR: "4604"

.changes/unreleased/Fixes-20220321-140921.yaml

@@ -0,0 +1,7 @@
+kind: Fixes
+body: A change in secret environment variables won't trigger a full reparse
+time: 2022-03-21T14:09:21.004543-05:00
+custom:
+  Author: nathaniel-may
+  Issue: "4650"
+  PR: "4665"

.changes/unreleased/Fixes-20220321-141007.yaml

@@ -0,0 +1,7 @@
+kind: Fixes
+body: Fix misspellings and typos in docstrings
+time: 2022-03-21T14:10:07.962502-05:00
+custom:
+  Author: kazanzhy
+  Issue: "4904"
+  PR: "4545"

.changes/unreleased/Under the Hood-20220321-141158.yaml

@@ -0,0 +1,7 @@
+kind: Under the Hood
+body: Testing cleanup
+time: 2022-03-21T14:11:58.750419-05:00
+custom:
+  Author: emmyoop
+  Issue: "3648"
+  PR: "4509"

.changes/unreleased/Under the Hood-20220321-141300.yaml

@@ -0,0 +1,7 @@
+kind: Under the Hood
+body: Clean up test deprecation warnings
+time: 2022-03-21T14:13:00.557425-05:00
+custom:
+  Author: gshank
+  Issue: "3988"
+  PR: "4556"

.changes/unreleased/Under the Hood-20220321-141338.yaml

@@ -0,0 +1,7 @@
+kind: Under the Hood
+body: Use mashumaro for serialization in event logging
+time: 2022-03-21T14:13:38.758158-05:00
+custom:
+  Author: gshank
+  Issue: "4504"
+  PR: "4505"

.changes/unreleased/Under the Hood-20220321-141451.yaml

@@ -0,0 +1,7 @@
+kind: Under the Hood
+body: Drop support for Python 3.7.0 + 3.7.1
+time: 2022-03-21T14:14:51.840637-05:00
+custom:
+  Author: nathaniel-may
+  Issue: "4584"
+  PR: "4585"

.changes/unreleased/Under the Hood-20220321-141523.yaml

@@ -0,0 +1,7 @@
+kind: Under the Hood
+body: Drop support for Python <3.7.2
+time: 2022-03-21T14:15:23.893773-05:00
+custom:
+  Author: jtcohen6
+  Issue: "4584"
+  PR: "4643"

.changes/unreleased/Under the Hood-20220321-141610.yaml

@@ -0,0 +1,7 @@
+kind: Under the Hood
+body: Re-format codebase (except tests) using pre-commit hooks
+time: 2022-03-21T14:16:10.285506-05:00
+custom:
+  Author: iknox-fa
+  Issue: "3195"
+  PR: "4697"

.changes/unreleased/Under the Hood-20220321-141707.yaml

@@ -0,0 +1,7 @@
+kind: Under the Hood
+body: Add deps module README
+time: 2022-03-21T14:17:07.884314-05:00
+custom:
+  Author: emmyoop
+  Issue: "4904"
+  PR: "4686"

.changes/unreleased/Under the Hood-20220321-141747.yaml

@@ -0,0 +1,7 @@
+kind: Under the Hood
+body: Initial conversion of tests to pytest
+time: 2022-03-21T14:17:47.852378-05:00
+custom:
+  Author: gshank
+  Issue: "4690"
+  PR: "4691"

.changes/unreleased/Under the Hood-20220321-142055.yaml

@@ -0,0 +1,7 @@
+kind: Under the Hood
+body: Fix errors in Windows for tests/functions
+time: 2022-03-21T14:20:55.648765-05:00
+custom:
+  Author: gshank
+  Issue: "4782"
+  PR: "4767"

.changie.yaml

@@ -46,5 +46,5 @@ footerFormat: |
     {{- end}}
   {{- end }}
   {{- range $k,$v := $contributorDict }}
-    - [{{$k}}](https://github.com/{{$k}}) ({{ range $index, $element := $v }}{{if $index}}, {{end}}[#{{$element}}](https://github.com/dbt-labs/dbt-core/pull/{{$element}}){{end}})
+    - [@{{$k}}](https://github.com/{{$k}}) ({{ range $index, $element := $v }}{{if $index}}, {{end}}[#{{$element}}](https://github.com/dbt-labs/dbt-core/pull/{{$element}}){{end}})
   {{- end }}

.github/workflows/changelog-check.yml

@@ -11,12 +11,16 @@
 # Ensure code change gets reflected in the CHANGELOG.
 
 # **when?**
-# This will run for all PRs going into main and *.latest.
+# This will run for all PRs going into main and *.latest.  It will
+# run when they are opened, reopened, when any label is added or removed
+# and when new code is pushed to the branch.  The action will then get
+# skipped if the 'Skip Changelog' label is present is any of the labels.
 
 name: Check Changelog Entry
 
 on:
   pull_request:
+    types: [opened, reopened, labeled, unlabeled, synchronize]
   workflow_dispatch:
 
 defaults:
@@ -33,6 +37,7 @@ env:
 jobs:
   changelog:
     name: changelog
+    if: "!contains(github.event.pull_request.labels.*.name, 'Skip Changelog')"
 
     runs-on: ubuntu-latest
 
@@ -61,16 +66,13 @@ jobs:
       - name: Create PR comment if changelog entry is missing, required, and does nto exist
         if: |
           steps.filter.outputs.changelog == 'false' &&
-          !contains( github.event.pull_request.labels.*.name, 'Skip Changelog') &&
           steps.changelog_comment.outputs.comment-body == ''
         uses: peter-evans/create-or-update-comment@v1
         with:
           issue-number: ${{ github.event.pull_request.number }}
           body: ${{ env.changelog_comment }}
       - name: Fail job if changelog entry is missing and required
-        if: |
-          steps.filter.outputs.changelog == 'false' &&
-          !contains( github.event.pull_request.labels.*.name, 'Skip Changelog')
+        if: steps.filter.outputs.changelog == 'false'
         uses: actions/github-script@v6
         with:
           script: core.setFailed('Changelog entry required to merge.')

CHANGELOG.md

@@ -6,7 +6,7 @@
 - Do not edit this file directly. This file is auto-generated using [changie](https://github.com/miniscruff/changie). For details on how to document a change, see [the contributing guide](https://github.com/dbt-labs/dbt-core/blob/main/CONTRIBUTING.md#adding-changelog-entry)
 
 
-*** below changes will need to be manually merged with the changes generated by `changie batch` for 1.1.0.  Once the two are merged, this file should be deleted.  This is a one time thing because changie was introduced mid-development. ***  
+*** below changes will automatically be updated & replaced with the changes generated by `changie batch`/`changie merge` for 1.1.0.  ***  
 
 ## dbt-core 1.1.0 (TBD)