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

Build Automation for Version Bump and Changelog #171

Open
wants to merge 19 commits into
base: main
Choose a base branch
from

Conversation

peterallenwebb
Copy link
Contributor

@peterallenwebb peterallenwebb commented Jul 29, 2024

resolves #92

Checklist

@codecov-commenter
Copy link

codecov-commenter commented Jul 30, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 64.31%. Comparing base (db99ddd) to head (0f86aca).

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #171   +/-   ##
=======================================
  Coverage   64.31%   64.31%           
=======================================
  Files          51       51           
  Lines        3228     3228           
=======================================
  Hits         2076     2076           
  Misses       1152     1152           
Flag Coverage Δ
unit 64.31% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@peterallenwebb peterallenwebb marked this pull request as ready for review July 30, 2024 17:41
@peterallenwebb peterallenwebb requested a review from a team as a code owner July 30, 2024 17:41
Copy link
Member

@emmyoop emmyoop left a comment

Choose a reason for hiding this comment

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

This is a good start. The changelogs aren't quite right. The comment at the file level of the changelog is the most relevant. There's some simplification that we can do to make the release a bit easier to follow as well.


## dbt-common 1.6.0 - July 16, 2024
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
## dbt-common 1.6.0 - July 16, 2024
## dbt-common 1.7.0 - July 30, 2024

Comment on lines +22 to +26
- Add to and to_columns to ColumnLevelConstraint and ModelLevelConstraint contracts ([#168](https://github.com/dbt-labs/dbt-common/issues/168))

## dbt-common 1.5.0 - July 2, 2024

## dbt-common 1.4.0 - June 18, 2024
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
- Add to and to_columns to ColumnLevelConstraint and ModelLevelConstraint contracts ([#168](https://github.com/dbt-labs/dbt-common/issues/168))
## dbt-common 1.5.0 - July 2, 2024
## dbt-common 1.4.0 - June 18, 2024
- Add to and to_columns to ColumnLevelConstraint and ModelLevelConstraint contracts ([#168](https://github.com/dbt-labs/dbt-common/issues/168))
## dbt-common 1.4.0 - June 18, 2024

- [@truls-p](https://github.com/truls-p) ([#6073](https://github.com/dbt-labs/dbt-common/issues/6073))


## dbt-common 0.1.0 - January 17, 2024
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
## dbt-common 0.1.0 - January 17, 2024

Copy link
Member

Choose a reason for hiding this comment

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

This makes me so happy.

Copy link
Member

Choose a reason for hiding this comment

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

There should be corresponding markdown files for each version. You can see it on the 1.8 branch of core here. Without the corresponding markdown files, the next time we generate a changelog all of this will be wiped out. Changie just restitches together all the version markdowns each time you generate a new changelog.

The changes I added below should be in those files, not this file.

description: "The release version number (i.e. 1.0.0b1)"
type: string
required: true
test_run:
Copy link
Member

Choose a reason for hiding this comment

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

I would combine test_run and deploy-to. If we're testing, deploy to pypi test, if we're not, deploy to pypi prod.

Comment on lines +35 to +37
target_branch:
required: true
type: string
Copy link
Member

Choose a reason for hiding this comment

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

Same here, with respect to main

Comment on lines +43 to +45
final_sha:
description: The new commit that includes the changelog and version bump.
value: ${{ jobs.determine-release-sha.outputs.final_sha }}
Copy link
Member

Choose a reason for hiding this comment

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

We'll still want this for when we're doing test runs

shell: bash

env:
PYTHON_TARGET_VERSION: 3.8
Copy link
Member

Choose a reason for hiding this comment

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

We use 3.11 in the other workflow, let's have this match

Comment on lines +96 to +98
- name: Build Artifacts
run: hatch build
shell: bash
Copy link
Member

Choose a reason for hiding this comment

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

I don't like that we built and tested in the first step, changed the code (version bump/changelog) and now we're building again and not testing.

Comment on lines +95 to +96
steps:
- name: Build Artifacts
Copy link
Member

Choose a reason for hiding this comment

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

Does this work? You should need to checkout the repo again (at the sha that comes out of the changelog/version bump job). Checkouts don't persist across jobs.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Yeah. Good catch. This part has not been tested. I'll fix that and do a test release to verify.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Finish release automation - version bump, changelogs, testing
3 participants