-
Notifications
You must be signed in to change notification settings - Fork 1.6k
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
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Nothing stands out 👍
There was a problem hiding this 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!
@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 I'm on board! |
Great! I made inclusion of the issue conditional for the Dependency and Security types. All other types should have issues associated with them. |
@McKnight-42 since the adapters don't have the |
- 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}}))' |
There was a problem hiding this comment.
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?
There was a problem hiding this comment.
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.
There was a problem hiding this comment.
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.
@jtcohen6 and @leahwicz thoughts on backporting this? It would only involve back porting the |
* 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
* 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
resolves dbt-labs/dbt-docs#290
Description
This PR does a few things, all concerning the formatting of changelogs via changie.
Docs
kinds back todbt-docs
instead of somewhat arbitrary issues/PRs within this repo. This is more accurate and will also allow us to automate moving changelogs fromdbt-docs
intodbt-core
.Dependency
andSecurity
since they are bot PRs with no real issue.dbt-docs
PR in the Contributors sectionChecklist
changie new
to create a changelog entry