stackabletech / operator-rs

A simple wrapper/framework around kube-rs to make implementing Operators/Controllers easier
Apache License 2.0
116 stars 12 forks source link

chore: Release crates #760

Closed NickLarsenNZ closed 5 months ago

NickLarsenNZ commented 5 months ago

Description


Operator upgrade instructions

Prerequisites

These appear to have already been done as part of the post-release tasks

For each operator

Definition of Done Checklist

# Reviewer
- [ ] Code contains useful comments
- [ ] (Integration-)Test cases added
- [ ] Documentation added or updated
- [ ] Changelog updated
- [ ] Cargo.toml only contains references to git tags (not specific commits or branches)
# Acceptance
- [ ] Feature Tracker has been updated
- [ ] Proper release label has been added
NickLarsenNZ commented 5 months ago

@Techassi, can you please suggest what the new tags should look like?

Considering how they will look in the downstream crates:

stackable-operator = { git = "https://github.com/stackabletech/operator-rs.git", tag = "stackable-operator0.66.0" }

Depending on your response, the examples in the PR description might need updating.

Techassi commented 5 months ago

@Techassi, can you please suggest what the new tags should look like?

Considering how they will look in the downstream crates:

stackable-operator = { git = "https://github.com/stackabletech/operator-rs.git", tag = "stackable-operator0.66.0" }

Depending on your response, the examples in the PR description might need updating.

I would use stackable-<CRATE>-<VERSION>, because we already use the same format in stackable-cockpit (The tag looks like this: stackablectl-24.3.1)


Regarding how it will look in the downstream crates: For now, the "awkward" tag is mostly fine, because you only ever need to change the suffixed version. At some point in the future we want to publish these crates on crates.io anyway. The dependencies would then look like this:

stackable-operator = "0.66.0"
stackable-certs = "0.2.0"

Additionally, the tag format will most likely also change when we eventually publish the crates and they might get renamed.