New process for running tests and publishing breadbox client #437

pgm · 2025-10-19T02:22:20Z

This branch contains changes which strive to make the testing and publishing of the breadbox client more reliable.

Specifically, this consists of:

removal of cz and replacing it with a python script, which allows the logic to be more tailored to our precise needs.
Moved logic out of github workflow steps into the python script which allows us to manually run the "bump and publish" process. (Either for real, or with --dryrun for debugging purposes.)
Changes to the breadbox_client test configs such that it automatically starts up an instance of breadbox as a fixture. This allows us to run pytest within github workflow and makes it easier to run tests as necessary.

Work in progress because all the steps around publishing have been removed

added httpx dependency added install of breadbox Bumping poetry version in case that helps more debugging build more debugging build more debugging build more debugging build more debugging more debugging more debugging more debugging build more debugging build more debugging build more debugging build more debugging build more debugging build added a new function for running a poetry command in virtual env added a new function for running a poetry command in virtual env added a new function for running a poetry command in virtual env added a new function for running a poetry command in virtual env added a new function for running a poetry command in virtual env added a new function for running a poetry command in virtual env Dropped unused settings variables for configuring broker url and backend

… regex and subprocess handling Co-authored-by: aider (vertex_ai/claude-3-7-sonnet@20250219) <[email protected]>

Co-authored-by: aider (vertex_ai/claude-3-7-sonnet@20250219) <[email protected]>

…nderstanding Co-authored-by: aider (vertex_ai/claude-3-7-sonnet@20250219) <[email protected]>

…ump script Co-authored-by: aider (vertex_ai/claude-3-7-sonnet@20250219) <[email protected]>

Co-authored-by: aider (vertex_ai/claude-3-7-sonnet@20250219) <[email protected]>

…script

…y run mode Co-authored-by: aider (vertex_ai/claude-3-7-sonnet@20250219) <[email protected]>

Co-authored-by: aider (vertex_ai/claude-3-7-sonnet@20250219) <[email protected]>

.github/workflows/build_breadbox_client.yaml

This reverts commit 62a2ba9.

snwessel

Looks good to me! I've found it really time consuming in the past to wait for the build/publish in github to finish before I can use the updated/published client. I really like that we'll be able to have a bit more control over when/where we run this!

And I like that there's now a separate build/test workflow for the client too! 🎉

snwessel · 2025-10-21T16:18:12Z

breadbox/breadbox/commands.py

+def update_client():
+    "Update the code for the breadbox client based. (Also saving out a new 'latest-breadbox-api.json' file)"
+
+    _export_api_spec("../breadbox-client/latest-breadbox-api.json")  # TODO: call helper


Is this a TODO that still needs to be done?

Not sure, but lets say "no" because no one is going to do this (or know what this refers to)

This is showing up as "new" because I moved commands.py from one directory to another and there were some changes so git doesn't seem to have figured out it was a rename and considers it as a delete+add.

I'll delete the TODO comment

snwessel · 2025-10-21T16:18:43Z

breadbox/breadbox/commands.py

+print("env")
+print(os.environ)
+print("cwd")
+print(os.getcwd())


Did you mean to leave these print statements in here?

Nope! I forgot about those. Left over from hacky debugging of what was going on when run by github.

Removing.

snwessel · 2025-10-21T16:54:06Z

breadbox-client/tests/breadbox_facade/conftest.py

+    # looking at the VIRTUAL_ENV enviornment variable.
+    #
+    # If you delete that variable, then `poetry` calls will correctly identify the venv based on the
+    # current working directory.


Thank you for the comment explaining this! I've definitely run into a similar issue before and had been very confused by it!

snwessel · 2025-10-23T20:45:25Z

@pgm is this ready to be merged in, or did you want to wait to talk about it at TPP?

I am hoping to make some small breadbox client updates, and I don't want to create conflicts with your changes here - but my changes can wait if you wanted to talk about this before merging it in.

github-actions and others added 30 commits October 17, 2025 09:37

WIP: Setting up a new build process for breadbox_client

13918ef

Work in progress because all the steps around publishing have been removed

github workflow fix

71df4c3

added yaml as a file to monitor

78cdbb5

Changed breadbox_client tests to spin up a breadbox instance on demand

51daeba

fixed pyright errors

fe958ae

If reading settings fails, leave celery unconfigured

7434898

added httpx dependency

b16631a

added install of breadbox

13d1aca

Bumping poetry version in case that helps

50d03a4

more debugging build

98385ec

more debugging build

7fd1c0f

more debugging build

6bf82c2

more debugging build

152fdf0

more debugging

ee6cc36

more debugging

7305b1b

more debugging

c31c4b5

more debugging build

ea35d8c

more debugging build

59f76f6

more debugging build

dfedb15

more debugging build

80262f3

more debugging build

ed2a3ac

more debugging build

3f5da6f

added a new function for running a poetry command in virtual env

b0d6d59

added a new function for running a poetry command in virtual env

456067b

added a new function for running a poetry command in virtual env

d7adc02

added a new function for running a poetry command in virtual env

9a83409

added a new function for running a poetry command in virtual env

5892807

added a new function for running a poetry command in virtual env

50afb4d

Dropped unused settings variables for configuring broker url and backend

4d73e62

pgm and others added 16 commits October 18, 2025 22:46

Added documentation and reverted some unneeded changes.

bd77d14

removed all cz references from pyproject files

f747f87

feat: add version bumping script for breadbox-client package

bd3214f

refactor: update version bumping and publishing scripts with improved…

76a3cb7

… regex and subprocess handling Co-authored-by: aider (vertex_ai/claude-3-7-sonnet@20250219) <[email protected]>

fix: resolve syntax errors in version bump script

40cbe05

Co-authored-by: aider (vertex_ai/claude-3-7-sonnet@20250219) <[email protected]>

feat: add detailed print statements for better script debugging and u…

759e814

…nderstanding Co-authored-by: aider (vertex_ai/claude-3-7-sonnet@20250219) <[email protected]>

feat: add --dryrun option to skip commits and publishing in version b…

200cac4

…ump script Co-authored-by: aider (vertex_ai/claude-3-7-sonnet@20250219) <[email protected]>

docs: add script documentation and usage overview

07d0077

Co-authored-by: aider (vertex_ai/claude-3-7-sonnet@20250219) <[email protected]>

refactor: update conventional commit types and handling

5320ac7

Co-authored-by: aider (vertex_ai/claude-3-7-sonnet@20250219) <[email protected]>

Removal of cz and in its place, run the new bump_version_and_publish …

7d88e12

…script

feat: add --dry-run-if-not-branch option to conditionally run in dr…

ad945ca

…y run mode Co-authored-by: aider (vertex_ai/claude-3-7-sonnet@20250219) <[email protected]>

refactor: remove unused import from version bump script

2a3e976

fix: raise assertion error when no previous version tag is found

2dc5873

Co-authored-by: aider (vertex_ai/claude-3-7-sonnet@20250219) <[email protected]>

refactor: print original commit subject instead of rule number

c887cd1

Co-authored-by: aider (vertex_ai/claude-3-7-sonnet@20250219) <[email protected]>

fix(breadbox): Added fixes to bump script

8f61ea9

Added --dry-run-if-not-branch to github workflow for breadbox client

3a4a9cf

github-advanced-security bot found potential problems Oct 21, 2025

View reviewed changes

.github/workflows/build_breadbox_client.yaml Fixed Show fixed Hide fixed

removed unneeded build yamls

9dbaa00

pgm changed the title ~~WIP: New process for building breadbox client~~ New process for running tests and publishing breadbox client Oct 21, 2025

pgm marked this pull request as ready for review October 21, 2025 15:18

pgm requested a review from snwessel October 21, 2025 15:18

pgm added 3 commits October 21, 2025 11:23

Removed spurious comment

f7cb481

added debugging statement

62a2ba9

Revert "added debugging statement"

b59ecc1

This reverts commit 62a2ba9.

snwessel approved these changes Oct 21, 2025

View reviewed changes

Removed debugging print statements as well as spurious "todo" comment

9f00134

pgm added 2 commits October 24, 2025 11:11

Merge branch 'master' into new-bb-client-publisher

68bd052

Merge branch 'master' into new-bb-client-publisher

d3c2f63

pgm merged commit 7ab29b8 into master Oct 24, 2025
16 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

New process for running tests and publishing breadbox client #437

New process for running tests and publishing breadbox client #437

Uh oh!

pgm commented Oct 19, 2025 •

edited

Loading

Uh oh!

Uh oh!

snwessel left a comment

Uh oh!

snwessel Oct 21, 2025

Uh oh!

pgm Oct 21, 2025

Uh oh!

snwessel Oct 21, 2025

Uh oh!

pgm Oct 21, 2025

Uh oh!

snwessel Oct 21, 2025

Uh oh!

snwessel commented Oct 23, 2025

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

New process for running tests and publishing breadbox client #437

New process for running tests and publishing breadbox client #437

Uh oh!

Conversation

pgm commented Oct 19, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

snwessel left a comment

Choose a reason for hiding this comment

Uh oh!

snwessel Oct 21, 2025

Choose a reason for hiding this comment

Uh oh!

pgm Oct 21, 2025

Choose a reason for hiding this comment

Uh oh!

snwessel Oct 21, 2025

Choose a reason for hiding this comment

Uh oh!

pgm Oct 21, 2025

Choose a reason for hiding this comment

Uh oh!

snwessel Oct 21, 2025

Choose a reason for hiding this comment

Uh oh!

snwessel commented Oct 23, 2025

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

pgm commented Oct 19, 2025 •

edited

Loading