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

link changelog to dbt-docs for Docs kind #5628

Merged
merged 9 commits into from
Aug 9, 2022
Merged

Conversation

emmyoop
Copy link
Member

@emmyoop emmyoop commented Aug 8, 2022

resolves dbt-labs/dbt-docs#290

Description

This PR does a few things, all concerning the formatting of changelogs via changie.

  1. Links Docs kinds back to dbt-docs instead of somewhat arbitrary issues/PRs within this repo. This is more accurate and will also allow us to automate moving changelogs from dbt-docs into dbt-core.
  2. Removes the link to the [CT-388] NO ISSUE #4904 for Kinds Dependency and Security since they are bot PRs with no real issue.
  3. Links to the dbt-docs PR in the Contributors section
  4. Adds newlines after various sections

Checklist

@emmyoop emmyoop added the Skip Changelog Skips GHA to check for changelog file label Aug 8, 2022
@emmyoop emmyoop requested a review from a team as a code owner August 8, 2022 16:44
@emmyoop emmyoop requested review from gshank and iknox-fa August 8, 2022 16:44
@cla-bot cla-bot bot added the cla:yes label Aug 8, 2022
@emmyoop emmyoop requested review from McKnight-42 and jtcohen6 and removed request for iknox-fa August 8, 2022 16:45
Copy link
Contributor

@stu-k stu-k left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nothing stands out 👍

Copy link
Contributor

@McKnight-42 McKnight-42 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looking good to me!

@emmyoop
Copy link
Member Author

emmyoop commented Aug 8, 2022

@jtcohen6 I'd like to know if you're on board with this change and it modifies the format of the CHANGELOG. It's pretty straight forward (no issue for dependency and security PRs + link directly to dbt-docs issues/PRs for Docs changes).

My only question is if security PRs should maybe include the issue if one is present since snyk is not the only thing making security changes?

@emmyoop emmyoop mentioned this pull request Aug 8, 2022
8 tasks
@jtcohen6
Copy link
Contributor

jtcohen6 commented Aug 8, 2022

@emmyoop I'm on board!

@emmyoop
Copy link
Member Author

emmyoop commented Aug 9, 2022

Great! I made inclusion of the issue conditional for the Dependency and Security types. All other types should have issues associated with them.

@emmyoop
Copy link
Member Author

emmyoop commented Aug 9, 2022

@McKnight-42 since the adapters don't have the Docs kind it's safe to exclude that part of the logic. But you should update the logic to conditionally include issues for the Dependency and Security kinds. Just opening tickets to do it eventually in each repo would suffice if you don't have bandwidth right now for it.

@emmyoop emmyoop merged commit 34960d8 into main Aug 9, 2022
@emmyoop emmyoop deleted the er/convert-changie-docs-kind branch August 9, 2022 14:19
Comment on lines +18 to +21
- label: Dependencies
changeFormat: '- {{.Body}} ({{if ne .Custom.Issue ""}}[#{{.Custom.Issue}}](https://github.com/dbt-labs/dbt-core/issues/{{.Custom.Issue}}), {{end}}[#{{.Custom.PR}}](https://github.com/dbt-labs/dbt-core/pull/{{.Custom.PR}}))'
- label: Security
changeFormat: '- {{.Body}} ({{if ne .Custom.Issue ""}}[#{{.Custom.Issue}}](https://github.com/dbt-labs/dbt-core/issues/{{.Custom.Issue}}), {{end}}[#{{.Custom.PR}}](https://github.com/dbt-labs/dbt-core/pull/{{.Custom.PR}}))'
Copy link
Contributor

@McKnight-42 McKnight-42 Aug 9, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just to clarify @emmyoop the addition for the conditional would just be adapter specific versions of this?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Exactly! Just adding these new lines into the .changie.yaml for every adapter.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Will add them now, since all the backports will be open will be easy addition great callout.

@emmyoop
Copy link
Member Author

emmyoop commented Aug 10, 2022

@jtcohen6 and @leahwicz thoughts on backporting this? It would only involve back porting the .changie.yaml to get the Docs and the dependency and security formatting changes. It's doubtful we would backport docs changes or even dependency changes, but security changes have a high likelyhood. Backporting this seems safer than not and being confused when we backport some security fix and changie balks at the yaml file.

VersusFacit pushed a commit that referenced this pull request Sep 5, 2022
* first pass

* tweaks

* convert to use dbt-docs links in contributors section

* fix eq check

* fix format of contributos prs

* update docs changelog to point back to dbt-docs

* update beta 1.3 docs changelog

* remove optional param

* make issue inclusion conditional on being filled
agoblet pushed a commit to BigDataRepublic/dbt-core that referenced this pull request Sep 16, 2022
* first pass

* tweaks

* convert to use dbt-docs links in contributors section

* fix eq check

* fix format of contributos prs

* update docs changelog to point back to dbt-docs

* update beta 1.3 docs changelog

* remove optional param

* make issue inclusion conditional on being filled
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
cla:yes Skip Changelog Skips GHA to check for changelog file
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[CT-834] Add changie
4 participants