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

[CT-1562] Remove PR# from changelogs #6332

Closed
21 of 22 tasks
emmyoop opened this issue Nov 29, 2022 · 4 comments · Fixed by #6374, dbt-labs/actions#53, dbt-labs/dbt-docs#351 or #6799
Closed
21 of 22 tasks

[CT-1562] Remove PR# from changelogs #6332

emmyoop opened this issue Nov 29, 2022 · 4 comments · Fixed by #6374, dbt-labs/actions#53, dbt-labs/dbt-docs#351 or #6799
Assignees
Labels
tech_debt Behind-the-scenes changes, with little direct impact on end-user functionality

Comments

@emmyoop
Copy link
Member

emmyoop commented Nov 29, 2022

The standard for changelogs in the industry is to link changes to either an issue or a PR, but generally not both. Currently we link to both for every changelog.

This pulls the profile name from args when constructing a RuntimeConfig in lib.py, enabling the dbt-server to override the value that's in the dbt_project.yml (https://github.com/dbt-labs/dbt-core/issues/6201, https://github.com/dbt-labs/dbt-core/pull/6202)

I propose we remove the PR from changelogs and only link to the issues related to the change. The only exception to this change would be dependabot and snyk changes because they never have issues. But for those we could remove the #4904 issue link completely and only link to the PR.

What's involved in this change:

  • update .changie.yaml to not use PR except for dependency and snyk changes.
    • dbt-core
    • dbt-snowflake
    • dbt-redshift
    • dbt-spark
    • dbt-bigquery
    • dbt-docs
  • update changelog-existence.yml to pass on changelog modification or addition, not only addition. This allow the check to pass when we add an associated issue to an existing chnagelog.
  • Go through existing changie yaml files and remove the PR lines
    • dbt-core
    • dbt-snowflake
    • dbt-redshift
    • dbt-spark
    • dbt-bigquery
    • dbt-docs
  • backport all the way to 1.1.latest in all repos - this allow future backports to work and not break changelog generation
    • dbt-core
    • dbt-snowflake
    • dbt-redshift
    • dbt-spark
    • dbt-bigquery
    • dbt-docs
@github-actions github-actions bot changed the title Remove PR# from changelogs [CT-1562] Remove PR# from changelogs Nov 29, 2022
@emmyoop emmyoop added tech_debt Behind-the-scenes changes, with little direct impact on end-user functionality triage labels Nov 29, 2022
@jtcohen6
Copy link
Contributor

@emmyoop Thanks for the thorough writeup, reflecting the conversation from Slack! I'm in favor of doing this.

The only exception to this change would be dependabot and snyk changes because they never have issues. But for those we could remove the #4904 issue link completely and only link to the PR.

👍

The other thing we discussed: A big change that's split into lots of little PRs (often against feature branches), all of which roll up into a single big coherent change. We should have a single big issue / epic, with links out to the PRs in its description, and a single changelog entry linking to that issue. Subsequent PRs can modify the changelog entry if they're expanding / modifying the scope of the overall change.

Examples:

@jtcohen6 jtcohen6 removed the triage label Nov 30, 2022
@jtcohen6
Copy link
Contributor

jtcohen6 commented Dec 1, 2022

Discussion:

  • Generally supportive of this change
  • Want to make sure that issues and PRs are always linked. (Could we add automation for this?)

@emmyoop
Copy link
Member Author

emmyoop commented Dec 3, 2022

We will want to backport this because it could otherwise cause changie to break the changelogs we backport.

@emmyoop
Copy link
Member Author

emmyoop commented Dec 6, 2022

This is also relevant for dbt-server!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
tech_debt Behind-the-scenes changes, with little direct impact on end-user functionality
Projects
None yet
2 participants