Skip to content

Commit a1ae9a1

Browse files
authored
chore(⏲): Add missing tool update tasks to templates (#1062)
* chore(issue_templates): Use YY.M.X placeholders * chore(issue_templates): Remove tasklists :sob: * chore(issue_templates): Add missing tool update tasks for cyclonedx and auditable
1 parent cbb5712 commit a1ae9a1

19 files changed

+243
-257
lines changed

.github/ISSUE_TEMPLATE/add-product.md

+2-3
Original file line numberDiff line numberDiff line change
@@ -10,8 +10,8 @@ projects: ['stackabletech/10']
1010
assignees: ''
1111
---
1212

13-
```[tasklist]
14-
### Tasks
13+
## Tasks
14+
1515
- [ ] Create a new top-level folder for the product. The name of the folder must
1616
use the lowercase product name.
1717
- [ ] Create a README.md file outlining special considerations required to
@@ -24,7 +24,6 @@ assignees: ''
2424
`.github/workflows` folder. Use existing local action whenever possible
2525
or consider creating a new one when there is no fitting action available.
2626
- [ ] Run `.scripts/update_readme_badges.sh` to generate the new status badge.
27-
```
2827

2928
_Please consider updating this template if these instructions are wrong, or
3029
could be made clearer._
+29-28
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
name: Early Pre-Release Container Image Updates
33
about: This template can be used to track the container image updates leading up to the next Stackable release
4-
title: "chore: Update Container Images for Stackable Release XX.(X)X"
4+
title: "chore: Update Container Images for Stackable Release YY.M.X"
55
labels: ['epic']
66
assignees: ''
77
---
@@ -14,49 +14,50 @@ assignees: ''
1414
<!-- Update this with the parent tracking issue for the release -->
1515
Part of stackabletech/issues#xxx.
1616

17-
## Container Image Updates for Stackable Release XX.(X)X
18-
1917
> [!NOTE]
2018
> Update the product versions based on what has been decided upon in the _Product Spreadsheet[^1]_.
2119
2220
[^1]: Currently this is a private spreadsheet
2321

24-
Replace the items in the task lists below with the subsequent tracking issue.
22+
> [!IMPORTANT]
23+
> Replace the items in the task lists below with the subsequent tracking issue.
24+
25+
## Product Container Images
2526

2627
<!--
2728
Find templates for bases/products:
2829
2930
find .github/ISSUE_TEMPLATE/update-*.md -printf "%f\n" \
3031
| sort \
31-
| xargs -I {} echo "- [ ] https://github.com/stackabletech/docker-images/issues/new?template={}"
32+
| xargs -I {} echo "- [ ] [Create issue from template: {}](https://github.com/stackabletech/docker-images/issues/new?template={})"
3233
-->
3334

3435
<!-- todo: consider removing the ubi*-rust-builder from the release process. -->
35-
```[tasklist]
36-
### Product Container Images
37-
- [ ] https://github.com/stackabletech/docker-images/issues/new?template=update-base-java.md
38-
- [ ] https://github.com/stackabletech/docker-images/issues/new?template=update-base-stackable.md
39-
- [ ] https://github.com/stackabletech/docker-images/issues/new?template=update-base-ubi-rust-builders.md
40-
- [ ] https://github.com/stackabletech/docker-images/issues/new?template=update-base-vector.md
41-
- [ ] https://github.com/stackabletech/docker-images/issues/new?template=update-product-airflow.md
42-
- [ ] https://github.com/stackabletech/docker-images/issues/new?template=update-product-druid.md
43-
- [ ] https://github.com/stackabletech/docker-images/issues/new?template=update-product-hbase-phoenix-omid.md
44-
- [ ] https://github.com/stackabletech/docker-images/issues/new?template=update-product-hdfs.md
45-
- [ ] https://github.com/stackabletech/docker-images/issues/new?template=update-product-hive.md
46-
- [ ] https://github.com/stackabletech/docker-images/issues/new?template=update-product-kafka.md
47-
- [ ] https://github.com/stackabletech/docker-images/issues/new?template=update-product-nifi.md
48-
- [ ] https://github.com/stackabletech/docker-images/issues/new?template=update-product-opa.md
49-
- [ ] https://github.com/stackabletech/docker-images/issues/new?template=update-product-spark.md
50-
- [ ] https://github.com/stackabletech/docker-images/issues/new?template=update-product-superset.md
51-
- [ ] https://github.com/stackabletech/docker-images/issues/new?template=update-product-trino.md
52-
- [ ] https://github.com/stackabletech/docker-images/issues/new?template=update-product-zookeeper.md
53-
```
54-
55-
```[tasklist]
56-
### Additional items which don't have a tracking issue
36+
37+
- [ ] [Create issue from template: update-base-java.md](https://github.com/stackabletech/docker-images/issues/new?template=update-base-java.md)
38+
- [ ] [Create issue from template: update-base-stackable.md](https://github.com/stackabletech/docker-images/issues/new?template=update-base-stackable.md)
39+
- [ ] [Create issue from template: update-base-ubi-rust-builders.md](https://github.com/stackabletech/docker-images/issues/new?template=update-base-ubi-rust-builders.md)
40+
- [ ] [Create issue from template: update-base-vector.md](https://github.com/stackabletech/docker-images/issues/new?template=update-base-vector.md)
41+
- [ ] [Create issue from template: update-product-airflow.md](https://github.com/stackabletech/docker-images/issues/new?template=update-product-airflow.md)
42+
- [ ] [Create issue from template: update-product-druid.md](https://github.com/stackabletech/docker-images/issues/new?template=update-product-druid.md)
43+
- [ ] [Create issue from template: update-product-hbase-phoenix-omid.md](https://github.com/stackabletech/docker-images/issues/new?template=update-product-hbase-phoenix-omid.md)
44+
- [ ] [Create issue from template: update-product-hdfs.md](https://github.com/stackabletech/docker-images/issues/new?template=update-product-hdfs.md)
45+
- [ ] [Create issue from template: update-product-hive.md](https://github.com/stackabletech/docker-images/issues/new?template=update-product-hive.md)
46+
- [ ] [Create issue from template: update-product-kafka.md](https://github.com/stackabletech/docker-images/issues/new?template=update-product-kafka.md)
47+
- [ ] [Create issue from template: update-product-nifi.md](https://github.com/stackabletech/docker-images/issues/new?template=update-product-nifi.md)
48+
- [ ] [Create issue from template: update-product-opa.md](https://github.com/stackabletech/docker-images/issues/new?template=update-product-opa.md)
49+
- [ ] [Create issue from template: update-product-spark.md](https://github.com/stackabletech/docker-images/issues/new?template=update-product-spark.md)
50+
- [ ] [Create issue from template: update-product-superset.md](https://github.com/stackabletech/docker-images/issues/new?template=update-product-superset.md)
51+
- [ ] [Create issue from template: update-product-trino.md](https://github.com/stackabletech/docker-images/issues/new?template=update-product-trino.md)
52+
- [ ] [Create issue from template: update-product-zookeeper.md](https://github.com/stackabletech/docker-images/issues/new?template=update-product-zookeeper.md)
53+
54+
## Additional items which don't have a tracking issue
55+
5756
- [ ] hello-world
5857
- [ ] krb5
5958
- [ ] tools
6059
- [ ] testing-tools
6160
- [ ] statsd_exporter
62-
```
61+
- [ ] cyclonedx-bom (pip)
62+
- [ ] cargo-cyclonedx (Look for: `CARGO_CYCLONEDX_CRATE_VERSION`)
63+
- [ ] cargo-auditable (Look for: `CARGO_AUDITABLE_CRATE_VERSION`)

.github/ISSUE_TEMPLATE/update-base-java.md

+10-11
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ about: >-
44
This template contains instructions specific to updating this product and/or
55
container image(s).
66
title: >-
7-
chore(java-bases): Update container images ahead of Stackable Release XX.(X)X
7+
chore(java-bases): Update container images ahead of Stackable Release YY.M.X
88
labels: []
99
# Currently, projects cannot be assigned via front-matter.
1010
projects: ['stackabletech/10']
@@ -39,25 +39,24 @@ we should also make new versions of Java available for use.
3939
> term `openjdk-headless`.
4040
> _It isn't perfect, as it will depend on what is available via microdnf._
4141
42-
```[tasklist]
43-
### Update tasks
42+
## Update tasks
43+
4444
- [ ] Add any new versions of java to both `java-base/versions.py` and `java-devel/versions.py`
4545
- [ ] Remove versions when there are no long any references (eg: `grep java- **/versions.py | grep "1.8.0"`)
46-
```
4746

48-
```[tasklist]
49-
### Related Pull Requests
47+
## Related Pull Requests
48+
5049
- [ ] _Link to the docker-images PR (product update)_
51-
```
5250

53-
This list should be completed by the assignee(s), once respective PRs have been merged. Once all items have been checked, the issue can be moved into _Development: Done_.
51+
## Acceptance
52+
53+
> [!TIP]
54+
> This list should be completed by the assignee(s), once respective PRs have been merged. Once all items have been
55+
> checked, the issue can be moved into _Development: Done_.
5456
55-
```[tasklist]
56-
### Acceptance
5757
- [ ] Can build a product image that uses the new version(s)
5858
- [ ] Both `java-base` and `java-devel` have the same Java versions in `versions.py`
5959
- [ ] Kuttl smoke test passes locally for a product using the new Java version
60-
```
6160

6261
<details>
6362
<summary>Testing instructions</summary>

.github/ISSUE_TEMPLATE/update-base-stackable.md

+10-11
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ about: >-
44
This template contains instructions specific to updating this product and/or
55
container image(s).
66
title: >-
7-
chore(stackable-base): Update container images ahead of Stackable Release XX.(X)X
7+
chore(stackable-base): Update container images ahead of Stackable Release YY.M.X
88
labels: []
99
# Currently, projects cannot be assigned via front-matter.
1010
projects: ['stackabletech/10']
@@ -25,28 +25,27 @@ Add/Change/Remove anything that isn't applicable anymore
2525
>
2626
> [1]: https://github.com/orgs/stackabletech/projects/10
2727
28-
```[tasklist]
29-
### Update tasks
28+
## Update tasks
29+
3030
- [ ] Update UBI version hash in the Dockerfile (`FROM`)
3131
- [ ] Update `RUST_DEFAULT_TOOLCHAIN_VERSION`
3232
- [ ] Update `CARGO_CYCLONEDX_CRATE_VERSION`
3333
- [ ] Update `CARGO_AUDITABLE_CRATE_VERSION`
3434
- [ ] Update `PROTOC_VERSION`
3535
- [ ] Update `CONFIG_UTILS_VERSION`
36-
```
3736

38-
```[tasklist]
39-
### Related Pull Requests
37+
## Related Pull Requests
38+
4039
- [ ] _Link to the docker-images PR (product update)_
41-
```
4240

43-
This list should be completed by the assignee(s), once respective PRs have been merged. Once all items have been checked, the issue can be moved into _Development: Done_.
41+
## Acceptance
42+
43+
> [!TIP]
44+
> This list should be completed by the assignee(s), once respective PRs have been merged. Once all items have been
45+
> checked, the issue can be moved into _Development: Done_.
4446
45-
```[tasklist]
46-
### Acceptance
4747
- [ ] Can build the image locally
4848
- [ ] Can build the vector image
49-
```
5049

5150
<details>
5251
<summary>Testing instructions</summary>

.github/ISSUE_TEMPLATE/update-base-ubi-rust-builders.md

+10-11
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ about: >-
44
This template contains instructions specific to updating this product and/or
55
container image(s).
66
title: >-
7-
chore(ubi-rust-builders): Update container images ahead of Stackable Release XX.(X)X
7+
chore(ubi-rust-builders): Update container images ahead of Stackable Release YY.M.X
88
labels: []
99
# Currently, projects cannot be assigned via front-matter.
1010
projects: ['stackabletech/10']
@@ -31,31 +31,30 @@ Add/Change/Remove anything that isn't applicable anymore
3131
>
3232
> [1]: https://github.com/orgs/stackabletech/projects/10
3333
34-
```[tasklist]
35-
### Update tasks
34+
## Update tasks
35+
3636
- [ ] Update UBI version hash in the Dockerfile (`FROM`)
3737
- [ ] Update `RUST_DEFAULT_TOOLCHAIN_VERSION`
3838
- [ ] Update `CARGO_CYCLONEDX_CRATE_VERSION`
3939
- [ ] Update `CARGO_AUDITABLE_CRATE_VERSION`
4040
- [ ] Update `PROTOC_VERSION`
41-
```
4241

43-
```[tasklist]
44-
### Related Pull Requests
42+
## Related Pull Requests
43+
4544
- [ ] _Link to the docker-images PR (product update)_
4645
- [ ] _Bump rust toolchain in operator-rs_
4746
- [ ] _Bump rust toolchain in operator-templating_
48-
```
4947

50-
This list should be completed by the assignee(s), once respective PRs have been merged. Once all items have been checked, the issue can be moved into _Development: Done_.
48+
## Acceptance
49+
50+
> [!TIP]
51+
> This list should be completed by the assignee(s), once respective PRs have been merged. Once all items have been
52+
> checked, the issue can be moved into _Development: Done_.
5153
52-
```[tasklist]
53-
### Acceptance
5454
- Done for [ubi8-rust-builder/Dockerfile](https://github.com/stackabletech/docker-images/blob/main/ubi8-rust-builder/Dockerfile)
5555
- Done for [ubi9-rust-builder/Dockerfile](https://github.com/stackabletech/docker-images/blob/main/ubi9-rust-builder/Dockerfile)
5656
- [ ] Can build the image locally
5757
- [ ] Can build an operator image
58-
```
5958

6059
<details>
6160
<summary>Testing instructions</summary>

.github/ISSUE_TEMPLATE/update-base-vector.md

+13-14
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ about: >-
44
This template contains instructions specific to updating this product and/or
55
container image(s).
66
title: >-
7-
chore(vector): Update container images ahead of Stackable Release XX.(X)X
7+
chore(vector): Update container images ahead of Stackable Release YY.M.X
88
labels: []
99
# Currently, projects cannot be assigned via front-matter.
1010
projects: ['stackabletech/10']
@@ -31,40 +31,39 @@ Add/Change/Remove anything that isn't applicable anymore
3131
> - Uses [stackable-base](https://github.com/stackabletech/docker-images/blob/main/stackable-base/Dockerfile).
3232
> - Used as a base for [java-base](https://github.com/stackabletech/docker-images/blob/main/java-base/Dockerfile).
3333
34-
```[tasklist]
35-
### Update tasks
34+
## Update tasks
35+
3636
- [ ] Update `versions.py` to reflect the agreed upon versions in the spreadsheet (including the removal of old versions).
3737
- [ ] Update all `versions.py` files which reference vector.
3838
- [ ] Upload new version (see `vector/upload_new_vector_version.sh`).
3939
- [ ] Update `versions.py` to the latest supported version of JVM (base and devel).
4040
- [ ] Update other dependencies if applicable (eg: inotify_tools, etc).
4141
- [ ] Check other operators (getting_started / kuttl / supported-versions) for usage of the versions. Add the PR(s) to the list below.
4242
- [ ] Update the version in demos. Add the PR(s) to the list below.
43-
```
4443

45-
```[tasklist]
46-
### Related Pull Requests
44+
## Related Pull Requests
45+
46+
> [!TIP]
47+
> Delete any items that do not apply so that all applicable items can be checked.
48+
> For example, if you add release notes to the documentation repository, you do not need the latter two criteria.
49+
4750
- [ ] _Link to the docker-images PR (product update)_
4851
- [ ] _Link to the operator PR (getting_started / kuttl / supported-versions)_
4952
- [ ] _Link to any other operator PRs (getting_started / kuttl)_
5053
- [ ] _Link to demo PR (raise against the `main` branch)_
5154
- [ ] _Link to the Release Notes PR in the documentation repo (if not a comment below)_
52-
```
5355

54-
> [!TIP]
55-
> Delete any items that do not apply so that all applicable items can be checked.
56-
> For example, if you add release notes to the documentation repository, you do not need the latter two criteria.
56+
## Acceptance
5757

58-
This list should be completed by the assignee(s), once respective PRs have been merged. Once all items have been checked, the issue can be moved into _Development: Done_.
58+
> [!TIP]
59+
> This list should be completed by the assignee(s), once respective PRs have been merged. Once all items have been
60+
> checked, the issue can be moved into _Development: Done_.
5961
60-
```[tasklist]
61-
### Acceptance
6262
- [ ] Can build image (either locally, or in CI)
6363
- [ ] Kuttl smoke tests passes (either locally, or in CI)
6464
- [ ] Release notes added to documentation and linked as a PR above
6565
- [ ] Release notes written in a comment below
6666
- [ ] Applicable `release-note` label added to this issue
67-
```
6867

6968
<details>
7069
<summary>Testing instructions</summary>

.github/ISSUE_TEMPLATE/update-product-airflow.md

+13-14
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ about: >-
44
This template contains instructions specific to updating this product and/or
55
container image(s).
66
title: >-
7-
chore(airflow): Update container images ahead of Stackable Release XX.(X)X
7+
chore(airflow): Update container images ahead of Stackable Release YY.M.X
88
labels: []
99
# Currently, projects cannot be assigned via front-matter.
1010
projects: ['stackabletech/10']
@@ -25,38 +25,37 @@ Add/Change/Remove anything that isn't applicable anymore
2525
>
2626
> [1]: https://github.com/orgs/stackabletech/projects/10
2727
28-
```[tasklist]
29-
### Update tasks
28+
## Update tasks
29+
3030
- [ ] Update `versions.py` to reflect the agreed upon versions in the spreadsheet (including the removal of old versions).
3131
- [ ] Download new constraints file (see `airflow/download_constraints.sh`).
3232
- [ ] Update other dependencies if applicable (eg: python, statsd_exporter, etc).
3333
- [ ] Check other operators (getting_started / kuttl / supported-versions) for usage of the versions. Add the PR(s) to the list below.
3434
- [ ] Update the version in demos. Add the PR(s) to the list below.
35-
```
3635

37-
```[tasklist]
38-
### Related Pull Requests
36+
## Related Pull Requests
37+
38+
> [!TIP]
39+
> Delete any items that do not apply so that all applicable items can be checked.
40+
> For example, if you add release notes to the documentation repository, you do not need the latter two criteria.
41+
3942
- [ ] _Link to the docker-images PR (product update)_
4043
- [ ] _Link to operator PR (getting_started / kuttl)_
4144
- [ ] _Link to any other operator PRs (getting_started / kuttl)_
4245
- [ ] _Link to demo PR (raise against the `main` branch)_
4346
- [ ] _Link to the Release Notes PR in the documentation repo (if not a comment below)_
44-
```
4547

46-
> [!TIP]
47-
> Delete any items that do not apply so that all applicable items can be checked.
48-
> For example, if you add release notes to the documentation repository, you do not need the latter two criteria.
48+
## Acceptance
4949

50-
This list should be completed by the assignee(s), once respective PRs have been merged. Once all items have been checked, the issue can be moved into _Development: Done_.
50+
> [!TIP]
51+
> This list should be completed by the assignee(s), once respective PRs have been merged. Once all items have been
52+
> checked, the issue can be moved into _Development: Done_.
5153
52-
```[tasklist]
53-
### Acceptance
5454
- [ ] Can build image (either locally, or in CI)
5555
- [ ] Kuttl smoke tests passes (either locally, or in CI)
5656
- [ ] Release notes added to documentation and linked as a PR above
5757
- [ ] Release notes written in a comment below
5858
- [ ] Applicable `release-note` label added to this issue
59-
```
6059

6160
<details>
6261
<summary>Testing instructions</summary>

0 commit comments

Comments
 (0)