From 102c9f2cc86fa1be350152c0855e73d86e62e2a7 Mon Sep 17 00:00:00 2001 From: Nick Larsen Date: Thu, 24 Apr 2025 17:04:24 +0200 Subject: [PATCH 1/2] chore(issue_templates): Remove tasklists --- .github/ISSUE_TEMPLATE/pre-release.md | 17 +++++------------ .markdownlint.yaml | 3 +++ .../pre-release-getting-started-script.md | 2 +- .../pre-release-rust-deps.md | 8 +++----- template/.github/pull_request_template.md | 17 +++++++---------- 5 files changed, 19 insertions(+), 28 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/pre-release.md b/.github/ISSUE_TEMPLATE/pre-release.md index 9c536972..facbb9d4 100644 --- a/.github/ISSUE_TEMPLATE/pre-release.md +++ b/.github/ISSUE_TEMPLATE/pre-release.md @@ -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: '' --- @@ -14,43 +14,37 @@ 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 - Part of -### 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 + - [ ] 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 @@ -62,8 +56,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_ @@ -81,4 +75,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_ -``` diff --git a/.markdownlint.yaml b/.markdownlint.yaml index 5af20365..75212ec5 100644 --- a/.markdownlint.yaml +++ b/.markdownlint.yaml @@ -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. diff --git a/template/.github/PULL_REQUEST_TEMPLATE/pre-release-getting-started-script.md b/template/.github/PULL_REQUEST_TEMPLATE/pre-release-getting-started-script.md index 0081b520..bc008c91 100644 --- a/template/.github/PULL_REQUEST_TEMPLATE/pre-release-getting-started-script.md +++ b/template/.github/PULL_REQUEST_TEMPLATE/pre-release-getting-started-script.md @@ -1,4 +1,4 @@ -# Check and Update Getting Started Script +## Check and Update Getting Started Script