Skip to content

chore(issue_templates): Remove tasklists #511

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

Merged
merged 2 commits into from
Apr 25, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 6 additions & 12 deletions .github/ISSUE_TEMPLATE/pre-release.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ about: |
This template can be used to track the update of various dependencies and
tooling in this repository as well as all downstream product operators leading
up to the next Stackable release
title: "chore: Pre-release updates"
title: "chore: Pre-release updates for Stackable Release YY.M.X"
labels: ['epic']
assignees: ''
---
Expand All @@ -14,43 +14,38 @@ assignees: ''
This was created by an issue template: https://github.com/stackabletech/operator-templating/issues/new/choose.
-->

## Pre-Release Updates for Stackable Release XX.(X)X

<!--
Replace 'TRACKING_ISSUE' with the applicable release tracking issue number.
-->

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

### Update pre-commit Workflow
## Update pre-commit Workflow

> [!NOTE]
> The pre-commit config and workflows need to be kept up-to-date to ensure
> usage of recent tooling versions. This requires some manual work in this
> repository.

```[tasklist]
### Tasks
- [ ] Update `python-version` in local and templated `pr_pre-commit.yml` workflow
- [ ] Update hook refs in local and templated `.pre-commit-config.yaml` file
- [ ] Update Hadolint version in the `config/versions.yaml` file
```

### Update Rust Toolchain
## Update Rust Toolchain

> [!NOTE]
> During a Stackable release we need to ensure that every product operator uses
> the latest Rust toolchain (used by us). To keep the toolchain in sync across
> all our operators, we update the version centrally in this repository.

```[tasklist]
### Tasks in this Repository

- [ ] Run `niv update` and test via `make run-dev`
- [ ] Update Rust toolchain in the `config/versions.yaml` file.
- [ ] Update Rust toolchain in UBI8, UBI9, and stackable-base images
- [ ] Generate downstream PRs using the ["Generate Downstream PRs"](https://github.com/stackabletech/operator-templating/actions/workflows/generate_prs.yml) action.
- [ ] [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.
- [ ] Merge downstream PRs, see below for more details.
```

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

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

```[tasklist]
### Tasks in Downstream Operator Repositories

- [ ] _PR for airflow-operator_
- [ ] _PR for commons-operator_
- [ ] _PR for druid-operator_
Expand All @@ -81,4 +76,3 @@ Replace the items in the task lists below with the applicable Pull Requests
- [ ] _PR for superset-operator_
- [ ] _PR for trino-operator_
- [ ] _PR for zookeeper-operator_
```
3 changes: 3 additions & 0 deletions .markdownlint.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -22,3 +22,6 @@ MD033:
MD024:
# Only check sibling headings
siblings_only: true

# MD041/first-line-heading/first-line-h1 First line in a file should be a top-level heading
MD041: false # Github issues and PRs already have titles, and H1 is enormous in the description box.
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Check and Update Getting Started Script
## Check and Update Getting Started Script

<!--
Make sure to update the link in 'issues/.github/ISSUE_TEMPLATE/pre-release-getting-started-scripts.md'
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Bump Rust Dependencies for Stackable Release YY.M.X
## Bump Rust Dependencies for Stackable Release YY.M.X

<!--
Make sure to update the link in 'issues/.github/ISSUE_TEMPLATE/pre-release-operator-rust-deps.md'
Expand All @@ -17,11 +17,10 @@ Part of <https://github.com/stackabletech/issues/issues/TRACKING_ISSUE>
> crates. These bumps also include previously updated and released crates from
> the `operator-rs` repository.

```[tasklist]
### Tasks

- [ ] Bump Rust Dependencies, see below for more details.
- [ ] Add changelog entry stating which important crates were bumped (including the version).
```

> [!NOTE]
> The bumping / updating of Rust dependencies is done in multiple steps:
Expand All @@ -30,9 +29,8 @@ Part of <https://github.com/stackabletech/issues/issues/TRACKING_ISSUE>
> 2. Run the `cargo update` command, which also updates the `Cargo.lock` file.
> 3. Lastly, run `make regenerate-nix` to update the `Cargo.nix` file.

```[tasklist]
### Bump Rust Dependencies

- [ ] Bump `stackable-operator` and friends
- [ ] Bump `product-config`
- [ ] Bump all other dependencies
```
17 changes: 7 additions & 10 deletions template/.github/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Description
## Description

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

Expand All @@ -7,29 +7,26 @@
- 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
- Please make sure all these things are done and tick the boxes

```[tasklist]
# Author
### Author

- [ ] Changes are OpenShift compatible
- [ ] CRD changes approved
- [ ] CRD documentation for all fields, following the [style guide](https://docs.stackable.tech/home/nightly/contributor/docs/style-guide).
- [ ] Helm chart can be installed and deployed operator works
- [ ] Integration tests passed (for non trivial changes)
- [ ] Changes need to be "offline" compatible
```

```[tasklist]
# Reviewer
### Reviewer

- [ ] Code contains useful comments
- [ ] Code contains useful logging statements
- [ ] (Integration-)Test cases added
- [ ] Documentation added or updated. Follows the [style guide](https://docs.stackable.tech/home/nightly/contributor/docs/style-guide).
- [ ] Changelog updated
- [ ] Cargo.toml only contains references to git tags (not specific commits or branches)
```

```[tasklist]
# Acceptance
### Acceptance

- [ ] Feature Tracker has been updated
- [ ] Proper release label has been added
- [ ] [Roadmap](https://github.com/orgs/stackabletech/projects/25/views/1) has been updated
```