Copy code from dbt core

.changes/header.tpl.md

@@ -1,6 +1,6 @@
-# Changelog
-All notable changes to this project will be documented in this file.
+# dbt Core Changelog
 
-The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
-adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html),
-and is generated by [Changie](https://github.com/miniscruff/changie).
+- This file provides a full account of all changes to `dbt-common`
+- Changes are listed under the (pre)release in which they first appear. Subsequent releases include changes from previous releases.
+- "Breaking changes" listed under a version may require action from end users or external maintainers when upgrading to that version.
+- 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-common/blob/main/CONTRIBUTING.md#adding-changelog-entry)

.changie.yaml

@@ -1,20 +1,66 @@
 changesDir: .changes
 unreleasedDir: unreleased
 headerPath: header.tpl.md
+versionHeaderPath: ""
 changelogPath: CHANGELOG.md
 versionExt: md
-envPrefix: CHANGIE_
-versionFormat: '## dbt-oss-template {{.Version}} - {{.Time.Format "January 02, 2006"}}'
+envPrefix: "CHANGIE_"
+versionFormat: '## dbt-common {{.Version}} - {{.Time.Format "January 02, 2006"}}'
 kindFormat: '### {{.Kind}}'
-changeFormat: '* {{.Body}}'
+changeFormat: |-
+ {{- $IssueList := list }}
+ {{- $changes := splitList " " $.Custom.Issue }}
+ {{- range $issueNbr := $changes }}
+ {{- $changeLink := "[#nbr](https://github.com/dbt-labs/dbt-common/issues/nbr)" | replace "nbr" $issueNbr }}
+ {{- $IssueList = append $IssueList $changeLink }}
+ {{- end -}}
+ - {{.Body}} ({{ range $index, $element := $IssueList }}{{if $index}}, {{end}}{{$element}}{{end}})
+
 kinds:
  - label: Breaking Changes
  - label: Features
  - label: Fixes
  - label: Docs
  - label: Under the Hood
  - label: Dependencies
+ changeFormat: |-
+ {{- $PRList := list }}
+ {{- $changes := splitList " " $.Custom.PR }}
+ {{- range $pullrequest := $changes }}
+ {{- $changeLink := "[#nbr](https://github.com/dbt-labs/dbt-common/pull/nbr)" | replace "nbr" $pullrequest }}
+ {{- $PRList = append $PRList $changeLink }}
+ {{- end -}}
+ - {{.Body}} ({{ range $index, $element := $PRList }}{{if $index}}, {{end}}{{$element}}{{end}})
+ skipGlobalChoices: true
+ additionalChoices:
+ - key: Author
+ label: GitHub Username(s) (separated by a single space if multiple)
+ type: string
+ minLength: 3
+ - key: PR
+ label: GitHub Pull Request Number (separated by a single space if multiple)
+ type: string
+ minLength: 1
  - label: Security
+ changeFormat: |-
+ {{- $PRList := list }}
+ {{- $changes := splitList " " $.Custom.PR }}
+ {{- range $pullrequest := $changes }}
+ {{- $changeLink := "[#nbr](https://github.com/dbt-labs/dbt-common/pull/nbr)" | replace "nbr" $pullrequest }}
+ {{- $PRList = append $PRList $changeLink }}
+ {{- end -}}
+ - {{.Body}} ({{ range $index, $element := $PRList }}{{if $index}}, {{end}}{{$element}}{{end}})
+ skipGlobalChoices: true
+ additionalChoices:
+ - key: Author
+ label: GitHub Username(s) (separated by a single space if multiple)
+ type: string
+ minLength: 3
+ - key: PR
+ label: GitHub Pull Request Number (separated by a single space if multiple)
+ type: string
+ minLength: 1
+
 newlines:
  afterChangelogHeader: 1
  afterKind: 1
@@ -31,3 +77,56 @@ custom:
  label: GitHub Issue Number (separated by a single space if multiple)
  type: string
  minLength: 1
+
+footerFormat: |
+ {{- $contributorDict := dict }}
+ {{- /* ensure all names in this list are all lowercase for later matching purposes */}}
+ {{- $core_team := splitList " " .Env.CORE_TEAM }}
+ {{- /* ensure we always skip snyk and dependabot in addition to the core team */}}
+ {{- $maintainers := list "dependabot[bot]" "snyk-bot"}}
+ {{- range $team_member := $core_team }}
+ {{- $team_member_lower := lower $team_member }}
+ {{- $maintainers = append $maintainers $team_member_lower }}
+ {{- end }}
+ {{- range $change := .Changes }}
+ {{- $authorList := splitList " " $change.Custom.Author }}
+ {{- /* loop through all authors for a single changelog */}}
+ {{- range $author := $authorList }}
+ {{- $authorLower := lower $author }}
+ {{- /* we only want to include non-core team contributors */}}
+ {{- if not (has $authorLower $maintainers)}}
+ {{- $changeList := splitList " " $change.Custom.Author }}
+ {{- $IssueList := list }}
+ {{- $changeLink := $change.Kind }}
+ {{- if or (eq $change.Kind "Dependencies") (eq $change.Kind "Security") }}
+ {{- $changes := splitList " " $change.Custom.PR }}
+ {{- range $issueNbr := $changes }}
+ {{- $changeLink := "[#nbr](https://github.com/dbt-labs/dbt-common/pull/nbr)" | replace "nbr" $issueNbr }}
+ {{- $IssueList = append $IssueList $changeLink }}
+ {{- end -}}
+ {{- else }}
+ {{- $changes := splitList " " $change.Custom.Issue }}
+ {{- range $issueNbr := $changes }}
+ {{- $changeLink := "[#nbr](https://github.com/dbt-labs/dbt-common/issues/nbr)" | replace "nbr" $issueNbr }}
+ {{- $IssueList = append $IssueList $changeLink }}
+ {{- end -}}
+ {{- end }}
+ {{- /* check if this contributor has other changes associated with them already */}}
+ {{- if hasKey $contributorDict $author }}
+ {{- $contributionList := get $contributorDict $author }}
+ {{- $contributionList = concat $contributionList $IssueList }}
+ {{- $contributorDict := set $contributorDict $author $contributionList }}
+ {{- else }}
+ {{- $contributionList := $IssueList }}
+ {{- $contributorDict := set $contributorDict $author $contributionList }}
+ {{- end }}
+ {{- end}}
+ {{- end}}
+ {{- end }}
+ {{- /* no indentation here for formatting so the final markdown doesn't have unneeded indentations */}}
+ {{- if $contributorDict}}
+ ### Contributors
+ {{- range $k,$v := $contributorDict }}
+ - [@{{$k}}](https://github.com/{{$k}}) ({{ range $index, $element := $v }}{{if $index}}, {{end}}{{$element}}{{end}})
+ {{- end }}
+ {{- end }}

.flake8

@@ -0,0 +1,14 @@
+[flake8]
+select =
+ E
+ W
+ F
+ignore =
+ W503 # makes Flake8 work like black
+ W504
+ E203 # makes Flake8 work like black
+ E741
+ E501 # long line checking is done in black
+exclude = test/
+per-file-ignores =
+ */__init__.py: F401

.github/ISSUE_TEMPLATE/bug-report.yml

@@ -0,0 +1,65 @@
+name: 🐞 Bug
+description: Report a bug or an issue you've found with dbt-common
+title: "[Bug] <title>"
+labels: ["bug", "triage"]
+body:
+ - type: markdown
+ attributes:
+ value: |
+ Thanks for taking the time to fill out this bug report!
+ - type: checkboxes
+ attributes:
+ label: Is this a new bug in dbt-common?
+ description: >
+ In other words, is this an error, flaw, failure or fault in our software?
+
+ If this is a bug that broke existing functionality that used to work, please open a regression issue.
+ If this is a request for help or troubleshooting code in your own dbt project, please join our [dbt Community Slack](https://www.getdbt.com/community/join-the-community/) or open a [Discussion question](https://github.com/dbt-labs/docs.getdbt.com/discussions).
+
+ Please search to see if an issue already exists for the bug you encountered.
+ options:
+ - label: I believe this is a new bug in dbt-common
+ required: true
+ - label: I have searched the existing issues, and I could not find an existing issue for this bug
+ required: true
+ - type: textarea
+ attributes:
+ label: Current Behavior
+ description: A concise description of what you're experiencing.
+ validations:
+ required: true
+ - type: textarea
+ attributes:
+ label: Expected Behavior
+ description: A concise description of what you expected to happen.
+ validations:
+ required: true
+ - type: textarea
+ attributes:
+ label: Steps To Reproduce
+ description: Steps to reproduce the behavior.
+ placeholder: |
+ 1. In this environment...
+ 2. With this config...
+ 3. Run '...'
+ 4. See error...
+ validations:
+ required: true
+ - type: textarea
+ id: logs
+ attributes:
+ label: Relevant log output
+ description: |
+ If applicable, log output to help explain your problem.
+ render: shell
+ validations:
+ required: false
+ - type: textarea
+ attributes:
+ label: Additional Context
+ description: |
+ Links? References? Anything that will give us more context about the issue you are encountering!
+
+ Tip: You can attach images or log files by clicking this area to highlight it and then dragging files in.
+ validations:
+ required: false

.github/ISSUE_TEMPLATE/config.yml

@@ -0,0 +1,8 @@
+blank_issues_enabled: false
+contact_links:
+ - name: Ask the community for help
+ url: https://github.com/dbt-labs/docs.getdbt.com/discussions
+ about: Need help troubleshooting? Check out our guide on how to ask
+ - name: Participate in Discussions
+ url: https://github.com/dbt-labs/dbt-common/discussions
+ about: Do you have a Big Idea for dbt-common? Read open discussions, or start a new one

.github/ISSUE_TEMPLATE/feature-request.yml

@@ -0,0 +1,59 @@
+name: ✨ Feature
+description: Propose a straightforward extension of dbt-common functionality
+title: "[Feature] <title>"
+labels: ["enhancement", "triage"]
+body:
+ - type: markdown
+ attributes:
+ value: |
+ Thanks for taking the time to fill out this feature request!
+ - type: checkboxes
+ attributes:
+ label: Is this your first time submitting a feature request?
+ description: >
+ We want to make sure that features are distinct and discoverable,
+ so that other members of the community can find them and offer their thoughts.
+
+ Issues are the right place to request straightforward extensions of existing dbt-common functionality.
+ For "big ideas" about future capabilities of dbt-common, we ask that you open a
+ [discussion](https://github.com/dbt-labs/dbt-common/discussions) in the "Ideas" category instead.
+ options:
+ - label: I have read the [expectations for open source contributors](https://docs.getdbt.com/docs/contributing/oss-expectations)
+ required: true
+ - label: I have searched the existing issues, and I could not find an existing issue for this feature
+ required: true
+ - label: I am requesting a straightforward extension of existing dbt functionality, rather than a Big Idea better suited to a discussion
+ required: true
+ - type: textarea
+ attributes:
+ label: Describe the feature
+ description: A clear and concise description of what you want to happen.
+ validations:
+ required: true
+ - type: textarea
+ attributes:
+ label: Describe alternatives you've considered
+ description: |
+ A clear and concise description of any alternative solutions or features you've considered.
+ validations:
+ required: false
+ - type: textarea
+ attributes:
+ label: Who will this benefit?
+ description: |
+ What kind of use case will this feature be useful for? Please be specific and provide examples, this will help us prioritize properly.
+ validations:
+ required: false
+ - type: input
+ attributes:
+ label: Are you interested in contributing this feature?
+ description: Let us know if you want to write some code, and how we can help.
+ validations:
+ required: false
+ - type: textarea
+ attributes:
+ label: Anything else?
+ description: |
+ Links? References? Anything that will give us more context about the feature you are suggesting!
+ validations:
+ required: false

.github/ISSUE_TEMPLATE/implementation-ticket.yml

@@ -0,0 +1,58 @@
+name: 🛠️ Implementation
+description: This is an implementation ticket intended for use by the maintainers of dbt-common
+title: "[<project>] <title>"
+labels: ["user docs"]
+body:
+ - type: markdown
+ attributes:
+ value: This is an implementation ticket intended for use by the maintainers of dbt-common
+ - type: checkboxes
+ attributes:
+ label: Housekeeping
+ description: >
+ A couple friendly reminders:
+ 1. Remove the `user docs` label if the scope of this work does not require changes to https://docs.getdbt.com/docs: no end-user interface (e.g. yml spec, CLI, error messages, etc) or functional changes
+ 2. Link any blocking issues in the "Blocked on" field under the "Core devs & maintainers" project.
+ options:
+ - label: I am a maintainer of dbt-common
+ required: true
+ - type: textarea
+ attributes:
+ label: Short description
+ description: |
+ Describe the scope of the ticket, a high-level implementation approach and any tradeoffs to consider
+ validations:
+ required: true
+ - type: textarea
+ attributes:
+ label: Acceptance criteria
+ description: |
+ What is the definition of done for this ticket? Include any relevant edge cases and/or test cases
+ validations:
+ required: true
+ - type: textarea
+ attributes:
+ label: Impact to Other Teams
+ description: |
+ Will this change impact other teams? Include details of the kinds of changes required (new tests, code changes, related tickets) and _add the relevant `Impact:[team]` label_.
+ placeholder: |
+ Example: This change impacts `dbt-redshift` because the tests will need to be modified. The `Impact:[Adapter]` label has been added.
+ validations:
+ required: true
+ - type: textarea
+ attributes:
+ label: Will backports be required?
+ description: |
+ Will this change need to be backported to previous versions? Add details, possible blockers to backporting and _add the relevant backport labels `backport 1.x.latest`_
+ placeholder: |
+ Example: Backport to 1.6.latest, 1.5.latest and 1.4.latest. Since 1.4 isn't using click, the backport may be complicated. The `backport 1.6.latest`, `backport 1.5.latest` and `backport 1.4.latest` labels have been added.
+ validations:
+ required: true
+ - type: textarea
+ attributes:
+ label: Context
+ description: |
+ Provide the "why", motivation, and alternative approaches considered -- linking to previous refinement issues, spikes, docs as appropriate
+ validations:
+ validations:
+ required: false