Skip to content

Commit 76d1ba2

Browse files
authored
chore: Add release 26.7 retro improvements (#650)
* chore(issue_templates): Improve pre-release template * feat(template): Use -Dwarnings for cargo doc, run with feature sets * chore(issue_templates): Use correct pre-commit config file name
1 parent ca104d6 commit 76d1ba2

2 files changed

Lines changed: 27 additions & 4 deletions

File tree

‎.github/ISSUE_TEMPLATE/pre-release.md‎

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -20,16 +20,17 @@ assignees: ''
2020

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

23-
## Update pre-commit Workflow
23+
## Update prek Workflow
2424

2525
> [!NOTE]
26-
> The pre-commit config and workflows need to be kept up-to-date to ensure
26+
> The prek config and workflows need to be kept up-to-date to ensure
2727
> usage of recent tooling versions. This requires some manual work in this
2828
> repository.
2929
30-
- [ ] Update `python-version` in local and templated `pr_pre-commit.yml` workflow
3130
- [ ] Update hook refs in local and templated `.pre-commit-config.yaml` file
3231
- [ ] Update Hadolint version in the `config/versions.yaml` file
32+
- [ ] Update Jinja2 CLI version in the `config/versions.yaml` file
33+
- [ ] Update Nix package manager version in the `config/versions.yaml` file
3334

3435
## Update Rust Toolchain
3536

@@ -46,7 +47,7 @@ Part of <https://github.com/stackabletech/issues/TRACKING_ISSUE>
4647
operator-rs and docker-images).
4748
- [ ] Update Rust toolchain in UBI10 and stackable-base images
4849
- [ ] Update cargo-cyclonedx and cargo-auditable in UBI10 and stackable-base images
49-
- [ ] Generate downstream PRs using the ["Generate Downstream PRs"](https://github.com/stackabletech/operator-templating/actions/workflows/generate_prs.yml) action. Use the following title for downstream PRs: `chore(template): Updates for SDP YY.M.X`.
50+
- [ ] Generate downstream PRs using the ["Generate Downstream PRs"](https://github.com/stackabletech/operator-templating/actions/workflows/generate_prs.yml) action. Use the following title for downstream PRs: `chore(template): Updates for SDP YY.M.X`. Additionally, put `Part of <THIS_ISSUE>` into the message to automatically link downstream PRs to the issue.
5051
- [ ] [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 list below.
5152
- [ ] Add the `release/YY.M.X` label to the downstream PRs and continue to merge them. See below for more details.
5253

‎template/.pre-commit-config.yaml.j2‎

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -108,11 +108,33 @@ repos:
108108
- id: cargo-doc
109109
name: cargo-doc
110110
language: system
111+
env:
112+
RUSTDOCFLAGS: "-D warnings"
111113
entry: cargo doc --no-deps --document-private-items
112114
stages: [pre-commit, pre-merge-commit]
113115
pass_filenames: false
114116
files: \.rs$|Cargo\.(toml|lock)
115117

118+
- id: cargo-doc-all-features
119+
name: cargo-doc-all-features
120+
language: system
121+
env:
122+
RUSTDOCFLAGS: "-D warnings"
123+
entry: cargo doc --no-deps --document-private-items --all-features
124+
stages: [pre-commit, pre-merge-commit]
125+
pass_filenames: false
126+
files: \.rs$|Cargo\.(toml|lock)
127+
128+
- id: cargo-doc-no-default-features
129+
name: cargo-doc-no-default-features
130+
language: system
131+
env:
132+
RUSTDOCFLAGS: "-D warnings"
133+
entry: cargo doc --no-deps --document-private-items --no-default-features
134+
stages: [pre-commit, pre-merge-commit]
135+
pass_filenames: false
136+
files: \.rs$|Cargo\.(toml|lock)
137+
116138
- id: cargo-test
117139
name: cargo-test
118140
language: system

0 commit comments

Comments
 (0)