Remaining issues with release-please

Open
#551 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
4/5
Estimated time
3-5 days
Newbie friendliness
35/100
Issue type
Bug
Clarity
Needs clarification
Activity status
Stale
Tech stack
helm, rust
Domain
build-system, devops, release

Research direction

Start by inspecting the release-please setup, the Cargo manifests under /backend, /backend/Cargo.lock, and the Helm chart metadata. Reproduce how released commits are selected and how version changes are generated for the Rust workspace and charts. Done means releases no longer repeat prior commits and the relevant Cargo.lock and Helm versions are updated without manual release-PR edits.

Written by the indexing model from the issue text.

Description

There are still a few remaining issues with our release-please (RP) setup

  1. Infinite loop of releases - When RP searches through our commits, it still includes commits that have already been released leading to duplicated releases with ever growing changelogs
  2. Cargo workspaces - RP will bump the versions in the Cargo.toml of each package (graph-proxy, sessionspaces) but it won't update the Cargo.lock file in /backend. This leads to a combination of manual and automatic version bumps. The Cargo-workspace plugin seems like the correct way to fix this, but unfortunately it does not seem to work with our current structure of subfolders /backend and /frontend.
  3. Helm chart versions are not bumped by RP - at least I couldn't find a way to do this. This means that for some releases (graph-proxy, sessionspaces, dashboard) we need to make an additional version bump commit on the release PR to do this. Not the end of the world, but a little annoying.
Dominant language
Rust
Stars
7
Forks
6
Avg merge
1d 8h
Merged PRs (30d)
56

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from DiamondLightSource/workflows

All issues in DiamondLightSource/workflows

Similar issues

More Rust issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.