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

chore: Add issue template file #826

Merged
merged 3 commits into from
Jul 12, 2024

Conversation

Techassi
Copy link
Member

@Techassi Techassi commented Jul 12, 2024

Part of stackabletech/issues#602

This adds a new issue template to create a tracking issue for pre-release workspace member updates and releases.


Preview

Update and Release Workspace Members for Stackable Release XX.(X)X

Note

During a Stackable release we update all dependencies in the operator-rs repository. After these bumps, each workspace member is released using an appropriate SemVer version. Later, each product operator repository can then use the updates crates.

Replace the items in the task lists below with the applicable Pull Requests

Tasks

Update Rust Version and Workflow Actions

Note

The PR is usually titled: chore: Bump Rust version and workflow actions

  1. Adjust the version of the channel in the rust-toolchain.toml file. See https://releases.rs.
  2. Adjust the version RUST_TOOLCHAIN_VERSION in the workflows:
    • .github/workflows/build.yml
    • .github/workflows/pre_commit.yaml
  3. Add a changelog entry.
  4. Update any actions (using the Git commit hash) in the workflows. Hint: Also make sure that the cargo-udeps action is up-to-date, otherwise the CI might report errors.

Update Rust Dependencies

Note

This PR is usually titled: chore: Bump Rust dependencies

  1. Bump minor versions of dependencies in the Cargo.toml manifest.
  2. Then run the cargo update command.
  3. Fix any code which needs updating due to the dependency bumps.
  4. Locally update any product operator to identify any breaking changes downstream.
    • Hint: Use the [patch."https://github.com/..."] mechanism to temporarily override the dependency.
  5. Add a changelog entry if required.

Adjust Crate Versions

Warning

Currently, all workspace members use 0.X.Y versions. This means we can introduce breaking changes in any version without needing to bump the major level. But we still have the following rules:

  • Breaking changes (internally and externally) will bump the minor level of the version, so 0.X.Y becomes 0.X+1.Y.
  • All other non-breaking changes will bump the patch level of the version, so 0.X.Y becomes 0.X.Y+1.

Note

The PR is usually titled: chore: Release workspace members

  1. Bump the crate versions in their appropriate Cargo.toml manifests.
  2. Verify the previous step using .scripts/verify_crate_versions.sh.

Copy link
Member

@NickLarsenNZ NickLarsenNZ left a comment

Choose a reason for hiding this comment

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

LGTM

@NickLarsenNZ NickLarsenNZ self-requested a review July 12, 2024 14:39
Copy link
Member

@NickLarsenNZ NickLarsenNZ left a comment

Choose a reason for hiding this comment

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

Minor things

.github/ISSUE_TEMPLATE/release-workspace-members.md Outdated Show resolved Hide resolved
.github/ISSUE_TEMPLATE/release-workspace-members.md Outdated Show resolved Hide resolved
Copy link
Member

@NickLarsenNZ NickLarsenNZ left a comment

Choose a reason for hiding this comment

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

LGTM

@Techassi Techassi added this pull request to the merge queue Jul 12, 2024
Merged via the queue into main with commit e74b0c1 Jul 12, 2024
20 checks passed
@Techassi Techassi deleted the chore/add-release-workspace-member-issue-template branch July 12, 2024 14:54
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Archived in project
Development

Successfully merging this pull request may close these issues.

2 participants