Skip to content

Commit b05299a

Browse files
authored
chore(issue_templates): Remove tasklists (#511)
* chore(issue_templates): Remove tasklists * chore: move niv update to this template
1 parent e00f734 commit b05299a

File tree

5 files changed

+20
-28
lines changed

5 files changed

+20
-28
lines changed

.github/ISSUE_TEMPLATE/pre-release.md

+6-12
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ about: |
44
This template can be used to track the update of various dependencies and
55
tooling in this repository as well as all downstream product operators leading
66
up to the next Stackable release
7-
title: "chore: Pre-release updates"
7+
title: "chore: Pre-release updates for Stackable Release YY.M.X"
88
labels: ['epic']
99
assignees: ''
1010
---
@@ -14,43 +14,38 @@ assignees: ''
1414
This was created by an issue template: https://github.com/stackabletech/operator-templating/issues/new/choose.
1515
-->
1616

17-
## Pre-Release Updates for Stackable Release XX.(X)X
18-
1917
<!--
2018
Replace 'TRACKING_ISSUE' with the applicable release tracking issue number.
2119
-->
2220

2321
Part of <https://github.com/stackabletech/issues/TRACKING_ISSUE>
2422

25-
### Update pre-commit Workflow
23+
## Update pre-commit Workflow
2624

2725
> [!NOTE]
2826
> The pre-commit config and workflows need to be kept up-to-date to ensure
2927
> usage of recent tooling versions. This requires some manual work in this
3028
> repository.
3129
32-
```[tasklist]
33-
### Tasks
3430
- [ ] Update `python-version` in local and templated `pr_pre-commit.yml` workflow
3531
- [ ] Update hook refs in local and templated `.pre-commit-config.yaml` file
3632
- [ ] Update Hadolint version in the `config/versions.yaml` file
37-
```
3833

39-
### Update Rust Toolchain
34+
## Update Rust Toolchain
4035

4136
> [!NOTE]
4237
> During a Stackable release we need to ensure that every product operator uses
4338
> the latest Rust toolchain (used by us). To keep the toolchain in sync across
4439
> all our operators, we update the version centrally in this repository.
4540
46-
```[tasklist]
4741
### Tasks in this Repository
42+
43+
- [ ] Run `niv update` and test via `make run-dev`
4844
- [ ] Update Rust toolchain in the `config/versions.yaml` file.
4945
- [ ] Update Rust toolchain in UBI8, UBI9, and stackable-base images
5046
- [ ] Generate downstream PRs using the ["Generate Downstream PRs"](https://github.com/stackabletech/operator-templating/actions/workflows/generate_prs.yml) action.
5147
- [ ] [Search for PRs](https://github.com/search?q=org%3Astackabletech%20sort%3Aupdated-desc%20is%3Apr%20is%3Aopen%20Update%20templated%20files&type=pullrequests) and add them to the task list below.
5248
- [ ] Merge downstream PRs, see below for more details.
53-
```
5449

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

@@ -62,8 +57,8 @@ Replace the items in the task lists below with the applicable Pull Requests
6257
| xargs -I {} echo "- [ ] _PR for {}_"
6358
-->
6459

65-
```[tasklist]
6660
### Tasks in Downstream Operator Repositories
61+
6762
- [ ] _PR for airflow-operator_
6863
- [ ] _PR for commons-operator_
6964
- [ ] _PR for druid-operator_
@@ -81,4 +76,3 @@ Replace the items in the task lists below with the applicable Pull Requests
8176
- [ ] _PR for superset-operator_
8277
- [ ] _PR for trino-operator_
8378
- [ ] _PR for zookeeper-operator_
84-
```

.markdownlint.yaml

+3
Original file line numberDiff line numberDiff line change
@@ -22,3 +22,6 @@ MD033:
2222
MD024:
2323
# Only check sibling headings
2424
siblings_only: true
25+
26+
# MD041/first-line-heading/first-line-h1 First line in a file should be a top-level heading
27+
MD041: false # Github issues and PRs already have titles, and H1 is enormous in the description box.

template/.github/PULL_REQUEST_TEMPLATE/pre-release-getting-started-script.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Check and Update Getting Started Script
1+
## Check and Update Getting Started Script
22

33
<!--
44
Make sure to update the link in 'issues/.github/ISSUE_TEMPLATE/pre-release-getting-started-scripts.md'

template/.github/PULL_REQUEST_TEMPLATE/pre-release-rust-deps.md

+3-5
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Bump Rust Dependencies for Stackable Release YY.M.X
1+
## Bump Rust Dependencies for Stackable Release YY.M.X
22

33
<!--
44
Make sure to update the link in 'issues/.github/ISSUE_TEMPLATE/pre-release-operator-rust-deps.md'
@@ -17,11 +17,10 @@ Part of <https://github.com/stackabletech/issues/issues/TRACKING_ISSUE>
1717
> crates. These bumps also include previously updated and released crates from
1818
> the `operator-rs` repository.
1919
20-
```[tasklist]
2120
### Tasks
21+
2222
- [ ] Bump Rust Dependencies, see below for more details.
2323
- [ ] Add changelog entry stating which important crates were bumped (including the version).
24-
```
2524

2625
> [!NOTE]
2726
> The bumping / updating of Rust dependencies is done in multiple steps:
@@ -30,9 +29,8 @@ Part of <https://github.com/stackabletech/issues/issues/TRACKING_ISSUE>
3029
> 2. Run the `cargo update` command, which also updates the `Cargo.lock` file.
3130
> 3. Lastly, run `make regenerate-nix` to update the `Cargo.nix` file.
3231
33-
```[tasklist]
3432
### Bump Rust Dependencies
33+
3534
- [ ] Bump `stackable-operator` and friends
3635
- [ ] Bump `product-config`
3736
- [ ] Bump all other dependencies
38-
```
+7-10
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Description
1+
## Description
22

33
*Please add a description here. This will become the commit message of the merge request later.*
44

@@ -7,29 +7,26 @@
77
- Not all of these items are applicable to all PRs, the author should update this template to only leave the boxes in that are relevant
88
- Please make sure all these things are done and tick the boxes
99

10-
```[tasklist]
11-
# Author
10+
### Author
11+
1212
- [ ] Changes are OpenShift compatible
1313
- [ ] CRD changes approved
1414
- [ ] CRD documentation for all fields, following the [style guide](https://docs.stackable.tech/home/nightly/contributor/docs/style-guide).
1515
- [ ] Helm chart can be installed and deployed operator works
1616
- [ ] Integration tests passed (for non trivial changes)
1717
- [ ] Changes need to be "offline" compatible
18-
```
1918

20-
```[tasklist]
21-
# Reviewer
19+
### Reviewer
20+
2221
- [ ] Code contains useful comments
2322
- [ ] Code contains useful logging statements
2423
- [ ] (Integration-)Test cases added
2524
- [ ] Documentation added or updated. Follows the [style guide](https://docs.stackable.tech/home/nightly/contributor/docs/style-guide).
2625
- [ ] Changelog updated
2726
- [ ] Cargo.toml only contains references to git tags (not specific commits or branches)
28-
```
2927

30-
```[tasklist]
31-
# Acceptance
28+
### Acceptance
29+
3230
- [ ] Feature Tracker has been updated
3331
- [ ] Proper release label has been added
3432
- [ ] [Roadmap](https://github.com/orgs/stackabletech/projects/25/views/1) has been updated
35-
```

0 commit comments

Comments
 (0)