Skip to content

Commit f2f4695

Browse files
chore: Add pre-release issue and PR templates (#407)
* chore: Add pre-release issue and PR templates * Apply suggestions Co-authored-by: Nick <[email protected]> * chore: Add more detailed steps on how to bump Rust deps --------- Co-authored-by: Nick <[email protected]>
1 parent 9c880c6 commit f2f4695

File tree

2 files changed

+101
-0
lines changed

2 files changed

+101
-0
lines changed

.github/ISSUE_TEMPLATE/pre-release.md

Lines changed: 68 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,68 @@
1+
---
2+
name: Pre-Release Rust Toolchain Update
3+
about: This template can be used to track the update of the Rust toolchain in this repository as well as all downstream product operators leading up to the next Stackable release
4+
title: "chore: Update Rust toolchain to 1.XX"
5+
labels: ['epic']
6+
assignees: ''
7+
---
8+
9+
<!--
10+
DO NOT REMOVE THIS COMMENT. It is intended for people who might copy/paste from the previous release issue.
11+
This was created by an issue template: https://github.com/stackabletech/operator-templating/issues/new/choose.
12+
-->
13+
14+
## Pre-Release Rust Toolchain Update for Stackable Release XX.(X)X
15+
16+
<!--
17+
Replace 'TRACKING_ISSUE' with the applicable release tracking issue number.
18+
-->
19+
20+
Part of <https://github.com/stackabletech/issues/TRACKING_ISSUE>
21+
22+
> [!NOTE]
23+
> During a Stackable release we need to ensure that every product operator uses
24+
> the latest Rust toolchain (used by us). To keep the toolchain in sync across
25+
> all our operators, we update the version centrally in this repository.
26+
27+
### Update Rust Toolchain
28+
29+
```[tasklist]
30+
### Tasks in this Repository
31+
- [ ] Update Rust toolchain in the `config/rust.yaml` file.
32+
- [ ] Generate downstream PRs using the ["Generate Downstream PRs"](https://github.com/stackabletech/operator-templating/actions/workflows/generate_prs.yml) action.
33+
- [ ] Merge downstream PRs, see below for more details.
34+
```
35+
36+
### Merge Downstream PRs
37+
38+
Replace the items in the task lists below with the applicable Pull Requests
39+
40+
<!--
41+
The following list was generated by:
42+
43+
yq '.repositories[].name' config/repositories.yaml \
44+
| sort \
45+
| xargs -I {} echo "- [ ] https://github.com/stackabletech/{}/pulls?q=sort:updated-desc+is:pr+is:open+Update+templated+files"
46+
-->
47+
48+
```[tasklist]
49+
### Tasks in Downstream Repositories
50+
- [ ] https://github.com/stackabletech/airflow-operator/pulls?q=sort:updated-desc+is:pr+is:open+Update+templated+files
51+
- [ ] https://github.com/stackabletech/commons-operator/pulls?q=sort:updated-desc+is:pr+is:open+Update+templated+files
52+
- [ ] https://github.com/stackabletech/druid-operator/pulls?q=sort:updated-desc+is:pr+is:open+Update+templated+files
53+
- [ ] https://github.com/stackabletech/edc-operator/pulls?q=sort:updated-desc+is:pr+is:open+Update+templated+files
54+
- [ ] https://github.com/stackabletech/hbase-operator/pulls?q=sort:updated-desc+is:pr+is:open+Update+templated+files
55+
- [ ] https://github.com/stackabletech/hdfs-operator/pulls?q=sort:updated-desc+is:pr+is:open+Update+templated+files
56+
- [ ] https://github.com/stackabletech/hello-world-operator/pulls?q=sort:updated-desc+is:pr+is:open+Update+templated+files
57+
- [ ] https://github.com/stackabletech/hive-operator/pulls?q=sort:updated-desc+is:pr+is:open+Update+templated+files
58+
- [ ] https://github.com/stackabletech/kafka-operator/pulls?q=sort:updated-desc+is:pr+is:open+Update+templated+files
59+
- [ ] https://github.com/stackabletech/listener-operator/pulls?q=sort:updated-desc+is:pr+is:open+Update+templated+files
60+
- [ ] https://github.com/stackabletech/nifi-operator/pulls?q=sort:updated-desc+is:pr+is:open+Update+templated+files
61+
- [ ] https://github.com/stackabletech/opa-operator/pulls?q=sort:updated-desc+is:pr+is:open+Update+templated+files
62+
- [ ] https://github.com/stackabletech/secret-operator/pulls?q=sort:updated-desc+is:pr+is:open+Update+templated+files
63+
- [ ] https://github.com/stackabletech/spark-k8s-operator/pulls?q=sort:updated-desc+is:pr+is:open+Update+templated+files
64+
- [ ] https://github.com/stackabletech/superset-operator/pulls?q=sort:updated-desc+is:pr+is:open+Update+templated+files
65+
- [ ] https://github.com/stackabletech/trino-operator/pulls?q=sort:updated-desc+is:pr+is:open+Update+templated+files
66+
- [ ] https://github.com/stackabletech/zookeeper-operator/pulls?q=sort:updated-desc+is:pr+is:open+Update+templated+files
67+
68+
```
Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
## Bump Rust Dependencies for Stackable Release XX.(X)X
2+
3+
<!--
4+
Replace 'TRACKING_ISSUE' with the applicable release tracking issue number.
5+
-->
6+
7+
Part of <https://github.com/stackabletech/issues/TRACKING_ISSUE>
8+
9+
> [!NOTE]
10+
> During a Stackable release we need to update various Rust dependencies before
11+
> entering the final release period to ensure we run the latest versions of
12+
> crates. These bumps also include previously updated and released crates from
13+
> the `operator-rs` repository.
14+
15+
```[tasklist]
16+
### Tasks
17+
- [ ] Bump Rust Dependencies, see below for more details.
18+
- [ ] Add changelog entry stating which important crates were bumped (including the version).
19+
```
20+
21+
> [!NOTE]
22+
> The bumping / updating of Rust dependencies is done in multiple steps:
23+
>
24+
> 1. Update the minimum Version in the root `Cargo.toml` manifest.
25+
> 2. Run the `cargo update` command, which also updates the `Cargo.lock` file.
26+
> 3. Lastly, run `make regenerate-nix` to update the `Cargo.nix` file.
27+
28+
```[tasklist]
29+
### Bump Rust Dependencies
30+
- [ ] Bump `stackable-operator` and friends.
31+
- [ ] Bump `product-version`.
32+
- [ ] Bump all other dependencies.
33+
```

0 commit comments

Comments
 (0)