Skip to content
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.

Sign up for GitHub

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

chore: Add getting-started scripts PR template #408

Merged
merged 1 commit into from
Jul 16, 2024
Merged

chore: Add getting-started scripts PR template #408

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
34 changes: 34 additions & 0 deletions template/.github/PULL_REQUEST_TEMPLATE/pre-release-getting-started-script.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
## Check and Update Getting Started Script
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think the linter isn't running, as in the downstream repos it picks this up:

template/.github/PULL_REQUEST_TEMPLATE/pre-release-getting-started-script.md:1 MD041/first-line-heading/first-line-h1 First line in a file should be a top-level heading [Context: "## Check and Update Getting St..."]


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

Check notice on line 4 in template/.github/PULL_REQUEST_TEMPLATE/pre-release-getting-started-script.md

View workflow job for this annotation

GitHub Actions / LanguageTool

[LanguageTool] template/.github/PULL_REQUEST_TEMPLATE/pre-release-getting-started-script.md#L4 

The official name of this software platform is spelled with a capital “H”. (GITHUB[1])
Suggestions: `GitHub`
URL: https://en.wikipedia.org/wiki/GitHub 
Rule: https://community.languagetool.org/rule/show/GITHUB?lang=en-US&subId=1
Category: CASING
Raw output 
template/.github/PULL_REQUEST_TEMPLATE/pre-release-getting-started-script.md:4:45: The official name of this software platform is spelled with a capital “H”. (GITHUB[1])
 Suggestions: `GitHub`
 URL: https://en.wikipedia.org/wiki/GitHub 
 Rule: https://community.languagetool.org/rule/show/GITHUB?lang=en-US&subId=1
 Category: CASING
when you rename this file.
-->

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

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

> [!NOTE]
> During a Stackable release we need to check (and optionally update) the
> getting-started scripts to ensure they still work after product and operator
> updates.

```shell
# Some of the scripts are in a code/ subdirectory
# pushd docs/modules/superset/examples/getting_started
# pushd docs/modules/superset/examples/getting_started/code
pushd $(fd -td getting_started | grep examples); cd code 2>/dev/null || true

# Make a fresh cluster (~12 seconds)
kind delete cluster && kind create cluster
./getting_started.sh stackablectl

# Make a fresh cluster (~12 seconds)
kind delete cluster && kind create cluster
./getting_started.sh helm

popd
```
7 changes: 6 additions & 1 deletion ...thub/PULL_REQUEST_TEMPLATE/pre-release.md → ...REQUEST_TEMPLATE/pre-release-rust-deps.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,10 +1,15 @@
## Bump Rust Dependencies for Stackable Release XX.(X)X
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

And this one:

template/.github/PULL_REQUEST_TEMPLATE/pre-release-rust-deps.md:1 MD041/first-line-heading/first-line-h1 First line in a file should be a top-level heading [Context: "## Bump Rust Dependencies for ..."]


<!--
Make sure to update the link in 'issues/.github/ISSUE_TEMPLATE/pre-release-operator-rust-deps.md'

Check notice on line 4 in template/.github/PULL_REQUEST_TEMPLATE/pre-release-rust-deps.md

View workflow job for this annotation

GitHub Actions / LanguageTool

[LanguageTool] template/.github/PULL_REQUEST_TEMPLATE/pre-release-rust-deps.md#L4 

The official name of this software platform is spelled with a capital “H”. (GITHUB[1])
Suggestions: `GitHub`
URL: https://en.wikipedia.org/wiki/GitHub 
Rule: https://community.languagetool.org/rule/show/GITHUB?lang=en-US&subId=1
Category: CASING
Raw output 
template/.github/PULL_REQUEST_TEMPLATE/pre-release-rust-deps.md:4:45: The official name of this software platform is spelled with a capital “H”. (GITHUB[1])
 Suggestions: `GitHub`
 URL: https://en.wikipedia.org/wiki/GitHub 
 Rule: https://community.languagetool.org/rule/show/GITHUB?lang=en-US&subId=1
 Category: CASING
when you rename this file.
-->

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

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

> [!NOTE]
> During a Stackable release we need to update various Rust dependencies before
Expand Down