Skip to content

Commit bf8b314

Browse files
authored
chore: Add pre-commit instructions to issue template (#435)
* chore: Remove unused pre-commit hooks * chore: Rename Ansible config file * chore: Add pre-commit instructions to issue template * Revert "chore: Remove unused pre-commit hooks" This reverts commit 8b3033d. * chore: Bump to Rust 1.80.1
1 parent 2a0772e commit bf8b314

File tree

3 files changed

+30
-17
lines changed

3 files changed

+30
-17
lines changed

.github/ISSUE_TEMPLATE/pre-release.md

Lines changed: 25 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,10 @@
11
---
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"
2+
name: Pre-Release Updates
3+
about: |
4+
This template can be used to track the update of various dependencies and
5+
tooling in this repository as well as all downstream product operators leading
6+
up to the next Stackable release
7+
title: "chore: Pre-release updates"
58
labels: ['epic']
69
assignees: ''
710
---
@@ -11,30 +14,42 @@ assignees: ''
1114
This was created by an issue template: https://github.com/stackabletech/operator-templating/issues/new/choose.
1215
-->
1316

14-
## Pre-Release Rust Toolchain Update for Stackable Release XX.(X)X
17+
## Pre-Release Updates for Stackable Release XX.(X)X
1518

1619
<!--
1720
Replace 'TRACKING_ISSUE' with the applicable release tracking issue number.
1821
-->
1922

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

25+
### Update pre-commit Workflow
26+
27+
> [!NOTE]
28+
> The pre-commit config and workflows need to be kept up-to-date to ensure
29+
> usage of recent tooling versions. This requires some manual work in this
30+
> repository.
31+
32+
```[tasklist]
33+
### Tasks
34+
- [ ] Update `python-version` in local and templated `pr_pre-commit.yml` workflow
35+
- [ ] Update hook refs in local and templated `.pre-commit-config.yaml` file
36+
- [ ] Update Hadolint version in the `config/versions.yaml` file
37+
```
38+
39+
### Update Rust Toolchain
40+
2241
> [!NOTE]
2342
> During a Stackable release we need to ensure that every product operator uses
2443
> the latest Rust toolchain (used by us). To keep the toolchain in sync across
2544
> all our operators, we update the version centrally in this repository.
2645
27-
### Update Rust Toolchain
28-
2946
```[tasklist]
3047
### Tasks in this Repository
31-
- [ ] Update Rust toolchain in the `config/rust.yaml` file.
48+
- [ ] Update Rust toolchain in the `config/versions.yaml` file.
3249
- [ ] Generate downstream PRs using the ["Generate Downstream PRs"](https://github.com/stackabletech/operator-templating/actions/workflows/generate_prs.yml) action.
3350
- [ ] Merge downstream PRs, see below for more details.
3451
```
3552

36-
### Merge Downstream PRs
37-
3853
Replace the items in the task lists below with the applicable Pull Requests
3954

4055
<!--
@@ -46,7 +61,7 @@ Replace the items in the task lists below with the applicable Pull Requests
4661
-->
4762

4863
```[tasklist]
49-
### Tasks in Downstream Repositories
64+
### Tasks in Downstream Operator Repositories
5065
- [ ] https://github.com/stackabletech/airflow-operator/pulls?q=sort:updated-desc+is:pr+is:open+Update+templated+files
5166
- [ ] https://github.com/stackabletech/commons-operator/pulls?q=sort:updated-desc+is:pr+is:open+Update+templated+files
5267
- [ ] https://github.com/stackabletech/druid-operator/pulls?q=sort:updated-desc+is:pr+is:open+Update+templated+files

.github/workflows/pr_pre-commit.yml

Lines changed: 0 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -5,8 +5,6 @@ on:
55
pull_request:
66

77
env:
8-
CARGO_TERM_COLOR: always
9-
RUST_TOOLCHAIN_VERSION: "1.80.1"
108
HADOLINT_VERSION: "v1.17.6"
119

1210
jobs:
@@ -19,10 +17,6 @@ jobs:
1917
- uses: actions/setup-python@f677139bbe7f9c59b41e40162b753c062f5d49a3 # v5.2.0
2018
with:
2119
python-version: '3.12'
22-
- uses: dtolnay/rust-toolchain@master
23-
with:
24-
toolchain: ${{ env.RUST_TOOLCHAIN_VERSION }}
25-
components: rustfmt,clippy
2620
- name: Setup Hadolint
2721
shell: bash
2822
run: |

config/rust.yaml renamed to config/versions.yaml

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,5 +2,9 @@
22
# IMPORTANT
33
# If you change the Rust toolchain version here, make sure to also change
44
# docker-images/ubi8-rust-builder/Dockerfile & docker-images/ubi9-rust-builder/Dockerfile
5-
rust_version: 1.80.0
5+
rust_version: 1.80.1
6+
7+
# IMPORTANT
8+
# If you change the Hadolint version here, make sure to also change the hook
9+
# refs in the local and template .pre-commit-config.yaml files.
610
hadolint_version: v2.12.0

0 commit comments

Comments
 (0)