Skip to content

Chore/update release naming - #421

Merged
victorsowa12 merged 9 commits into
developfrom
chore/update_release_naming
Sep 8, 2026
Merged

Chore/update release naming#421
victorsowa12 merged 9 commits into
developfrom
chore/update_release_naming

Conversation

@victorsowa12

@victorsowa12 victorsowa12 commented Sep 3, 2026

Copy link
Copy Markdown
Collaborator

What changed?

Changes the naming of release artifacts to follow: {name}-{build_type}-{version}. This makes sure that the artifacts follow a pattern and does not require us to remember to put "_release" or "-release" in the name of the config.

How does it make Bristlemouth better?

Removes our need to remember naming conventions.

Where should reviewers focus?

Testing:

Here is the resulting names after I ran auto_build.py locally on my machine:

(bristlemouth-ci) ➜  bm_protocol git:(chore/update_release_naming) ✗ ls cmake-build/bm_release_naming_testing
aanderaa_salinity-release-ENG-v0.13.12.zip           bootloader_signing_required-release-ENG-v0.13.12.zip bringup_bridge-debug-ENG-v0.13.12.zip                pme_do_sensor-release-ENG-v0.13.12.zip
aanderaa-release-ENG-v0.13.12.zip                    borealis-release-ENG-v0.13.12.zip                    bringup_mote_legacy-debug-ENG-v0.13.12.zip           seapoint_turbidity-release-ENG-v0.13.12.zip
bm_rbr-release-ENG-v0.13.12.zip                      borealis2-release-ENG-v0.13.12.zip                   bringup_mote-debug-ENG-v0.13.12.zip                  serial_bridge-debug-ENG-v0.13.12.zip
bm_soft_module-release-ENG-v0.13.12.zip              bridge-release-ENG-v0.13.12.zip                      hello_world-debug-ENG-v0.13.12.zip
bootloader_development-release-ENG-v0.13.12.zip      bringup_bridge_legacy-debug-ENG-v0.13.12.zip         mavlink_bridge-release-ENG-v0.13.12.zip

Checklist

  • Add or update unit tests for changed code
  • Ensure all submodules up to date. If this PR relies on changes in submodules, merge those PRs first, then point this PR at/after the merge commit
  • Ensure code is formatted correctly with clang-format. If there are large formatting changes, they should happen in a separate whitespace-only commit on this PR after all approvals.

pathlib.Path(args.out_dir).mkdir(parents=True, exist_ok=True)

builder.out_dir = args.out_dir
builder.out_dir = os.path.abspath(args.out_dir)

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

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

this helped me to be able to run auto_build.py locally. Otherwise an eventual scp command would return with a could not find directory error. I'm unsure if it will break the github runner, I don't think so, but would love a second opinion.

Comment on lines +204 to +210
output_name = ""
if config["args"]["build_type"]:
output_name = f"{config["name"]}-{config["args"]["build_type"].lower()}"
else:
output_name = config["name"]

cmd += ["--output-name", output_name]

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

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

this is where we will now append the build_type to the name of the output artifacts. Previously it used the "name".

@victorsowa12
victorsowa12 merged commit 085bdad into develop Sep 8, 2026
1 check passed
@victorsowa12
victorsowa12 deleted the chore/update_release_naming branch September 8, 2026 17:54
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants