Build Automation for Version Bump and Changelog #171

peterallenwebb · 2024-07-29T19:58:21Z

resolves #92

Checklist

I have read the contributing guide and understand what's expected of me
I have signed the CLA
I have run this code in development and it appears to resolve the stated issue
I have opened an issue to add/update docs, or docs changes are not required/relevant for this PR
I have run changie new to create a changelog entry

…mation

codecov-commenter · 2024-07-30T14:05:51Z

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.

…mation

emmyoop

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.

emmyoop · 2024-07-31T13:49:19Z

CHANGELOG.md


+## dbt-common 1.6.0 - July 16, 2024


Suggested change

## dbt-common 1.6.0 - July 16, 2024

## dbt-common 1.7.0 - July 30, 2024

emmyoop · 2024-07-31T13:50:59Z

CHANGELOG.md

+- 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


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

emmyoop · 2024-07-31T13:51:34Z

CHANGELOG.md

+- [@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


Suggested change

## dbt-common 0.1.0 - January 17, 2024

emmyoop · 2024-07-31T13:51:46Z

CHANGELOG.md

This makes me so happy.

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.

emmyoop · 2024-07-31T13:57:15Z

.github/workflows/release.yml

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


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

emmyoop · 2024-07-31T14:20:22Z

.github/workflows/release-prep.yml

+      target_branch:
+        required: true
+        type: string


Same here, with respect to main

emmyoop · 2024-07-31T14:20:52Z

.github/workflows/release-prep.yml

+      final_sha:
+        description: The new commit that includes the changelog and version bump.
+        value: ${{ jobs.determine-release-sha.outputs.final_sha }}


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

emmyoop · 2024-07-31T14:21:15Z

.github/workflows/release-prep.yml

+    shell: bash
+
+env:
+  PYTHON_TARGET_VERSION: 3.8


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

emmyoop · 2024-07-31T14:24:47Z

.github/workflows/release.yml

+      - name: Build Artifacts
+        run: hatch build
+        shell: bash


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.

emmyoop · 2024-07-31T14:25:32Z

.github/workflows/release.yml

+    steps:
+      - name: Build Artifacts


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.

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

peterallenwebb added 15 commits May 31, 2024 17:17

Automate changelog creation and version bump, etc.

540ff90

Fix relative path

b78e469

Really fix relative path this time, and restore correct version

82f8d8c

Restructure release workflow

c58b50b

Add missing YAML group

8b04aa2

Remove invalid runs-on property

64877f0

Remove invalid environment property

6f8997e

Remove another invalid enviornment property

3c01316

Add contents: write permission

fc5d5bd

Fix indentation

6bfc3e3

Move permissions

9b5107e

Install hatch

622fee2

Install hatch

1920532

Revise hatch command

2bde2f8

Merge remote-tracking branch 'origin/main' into paw/futher-build-auto…

87f6ad4

…mation

cla-bot bot added the cla:yes label Jul 29, 2024

peterallenwebb had a problem deploying to PypiTest July 29, 2024 20:01 — with GitHub Actions Failure

peterallenwebb temporarily deployed to PypiTest July 29, 2024 20:17 — with GitHub Actions Inactive

Revise release process.

a60033c

peterallenwebb added 3 commits July 30, 2024 11:17

Clean up changelog history

e816864

Add changelog entry, fix formatting

565f170

Merge remote-tracking branch 'origin/main' into paw/futher-build-auto…

0f86aca

…mation

peterallenwebb marked this pull request as ready for review July 30, 2024 17:41

peterallenwebb requested a review from a team as a code owner July 30, 2024 17:41

peterallenwebb temporarily deployed to PypiTest July 30, 2024 17:44 — with GitHub Actions Inactive

peterallenwebb temporarily deployed to PypiTest July 30, 2024 17:58 — with GitHub Actions Inactive

emmyoop requested changes Jul 31, 2024

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Build Automation for Version Bump and Changelog #171

Build Automation for Version Bump and Changelog #171

peterallenwebb commented Jul 29, 2024 •

edited

Loading

codecov-commenter commented Jul 30, 2024 •

edited

Loading

emmyoop left a comment •

edited

Loading

emmyoop Jul 31, 2024

emmyoop Jul 31, 2024

emmyoop Jul 31, 2024

emmyoop Jul 31, 2024

emmyoop Jul 31, 2024

emmyoop Jul 31, 2024

emmyoop Jul 31, 2024

emmyoop Jul 31, 2024

emmyoop Jul 31, 2024

emmyoop Jul 31, 2024

emmyoop Jul 31, 2024

peterallenwebb Jul 31, 2024

	## dbt-common 1.6.0 - July 16, 2024
	## dbt-common 1.7.0 - July 30, 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

Build Automation for Version Bump and Changelog #171

Are you sure you want to change the base?

Build Automation for Version Bump and Changelog #171

Conversation

peterallenwebb commented Jul 29, 2024 • edited Loading

Checklist

codecov-commenter commented Jul 30, 2024 • edited Loading

Codecov Report

emmyoop left a comment • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

peterallenwebb commented Jul 29, 2024 •

edited

Loading

codecov-commenter commented Jul 30, 2024 •

edited

Loading

emmyoop left a comment •

edited

Loading