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.

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

Improve 'Please run' messages in the CI #48365

Merged
merged 7 commits into from
Nov 4, 2024

Conversation

hugoShaka
Copy link
Contributor

@hugoShaka hugoShaka commented Nov 4, 2024

Quality of life changes: Teleport devs kept missing the "please run X" messages hidden in the action logs.
This PR adds a small helper that:

  • makes the instruction easier to find in the logs
  • collapses the diff in github actions
  • creates an error in the PR if running in github actions

This does not cover the Helm reference yet because the diff mechanism is a bit different. I might do more of this in the future if people think this helps (e.g. the license error).

What the error message looks like in the PR:
image

Example of collapsed logs in GHA:
image

Demo PR

@hugoShaka hugoShaka added the no-changelog Indicates that a PR does not require a changelog entry label Nov 4, 2024
@hugoShaka hugoShaka changed the title Improve 'Please run error' Improve 'Please run' messages in the CI Nov 4, 2024
@hugoShaka hugoShaka requested a review from codingllama November 4, 2024 16:29
@hugoShaka hugoShaka marked this pull request as ready for review November 4, 2024 16:29
@hugoShaka hugoShaka requested a review from kimlisa November 4, 2024 16:35
Makefile Outdated Show resolved Hide resolved
build.assets/tooling/cmd/please-run.sh Outdated Show resolved Hide resolved
build.assets/tooling/cmd/please-run.sh Outdated Show resolved Hide resolved
build.assets/tooling/cmd/please-run.sh Outdated Show resolved Hide resolved
build.assets/tooling/cmd/please-run.sh Outdated Show resolved Hide resolved
build.assets/tooling/cmd/please-run.sh Outdated Show resolved Hide resolved
build.assets/tooling/cmd/please-run.sh Outdated Show resolved Hide resolved
@@ -72,6 +72,9 @@ help: ## Display this help.

##@ Development

.PHONY: crd ## Single command to generate anything CRD-related (manifests and docs)
crd: crdgen crd-docs
Copy link
Contributor

Choose a reason for hiding this comment

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

Oh, nice.

Please backport this so workflows don't change between branches.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

👍 will backport the PR to every env

Copy link
Contributor

Choose a reason for hiding this comment

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

Thanks!

@hugoShaka hugoShaka requested a review from codingllama November 4, 2024 19:08
Copy link
Contributor

@codingllama codingllama left a comment

Choose a reason for hiding this comment

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

LGTM, just a couple of small suggestions.

Makefile Outdated Show resolved Hide resolved
build.assets/please-run.sh Outdated Show resolved Hide resolved
@@ -72,6 +72,9 @@ help: ## Display this help.

##@ Development

.PHONY: crd ## Single command to generate anything CRD-related (manifests and docs)
crd: crdgen crd-docs
Copy link
Contributor

Choose a reason for hiding this comment

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

Thanks!

hugoShaka and others added 2 commits November 4, 2024 15:03
Co-authored-by: Alan Parra <[email protected]>
@hugoShaka hugoShaka added this pull request to the merge queue Nov 4, 2024
Merged via the queue into master with commit 5d7eb65 Nov 4, 2024
40 checks passed
@hugoShaka hugoShaka deleted the hugo/improve-codegen-refresh-errors branch November 4, 2024 22:25
@public-teleport-github-review-bot

@hugoShaka See the table below for backport results.

Branch Result
branch/v14 Failed
branch/v15 Failed
branch/v16 Failed
branch/v17 Create PR

hugoShaka added a commit that referenced this pull request Nov 4, 2024
* Improve 'Please run error'

* add missing file

* fix script

* Apply suggestions from code review

Co-authored-by: Alan Parra <[email protected]>

* address alan's feedback

* Update Makefile

Co-authored-by: Alan Parra <[email protected]>

* Update build.assets/please-run.sh

Co-authored-by: Alan Parra <[email protected]>

---------

Co-authored-by: Alan Parra <[email protected]>
hugoShaka added a commit that referenced this pull request Nov 4, 2024
* Improve 'Please run error'

* add missing file

* fix script

* Apply suggestions from code review

Co-authored-by: Alan Parra <[email protected]>

* address alan's feedback

* Update Makefile

Co-authored-by: Alan Parra <[email protected]>

* Update build.assets/please-run.sh

Co-authored-by: Alan Parra <[email protected]>

---------

Co-authored-by: Alan Parra <[email protected]>
github-merge-queue bot pushed a commit that referenced this pull request Nov 5, 2024
* Improve 'Please run error'

* add missing file

* fix script

* Apply suggestions from code review



* address alan's feedback

* Update Makefile



* Update build.assets/please-run.sh



---------

Co-authored-by: Alan Parra <[email protected]>
github-merge-queue bot pushed a commit that referenced this pull request Nov 5, 2024
* Improve 'Please run error'

* add missing file

* fix script

* Apply suggestions from code review



* address alan's feedback

* Update Makefile



* Update build.assets/please-run.sh



---------

Co-authored-by: Alan Parra <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants