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

Wrong ::warning example #34450

Closed
1 task done
lfdominguez opened this issue Aug 30, 2024 · 12 comments
Closed
1 task done

Wrong ::warning example #34450

lfdominguez opened this issue Aug 30, 2024 · 12 comments
Labels
actions This issue or pull request should be reviewed by the docs actions team content This issue or pull request belongs to the Docs Content team needs SME This proposal needs review from a subject matter expert

Comments

@lfdominguez
Copy link
Contributor

Code of Conduct

What article on docs.github.com is affected?

https://docs.github.com/en/actions/writing-workflows/choosing-what-your-workflow-does/workflow-commands-for-github-actions?tool=bash

What part(s) of the article would you like to see updated?

The ::warning message example needs a title=. Because on the table show as a required parameter

Additional information

No response

@lfdominguez lfdominguez added the content This issue or pull request belongs to the Docs Content team label Aug 30, 2024
Copy link

welcome bot commented Aug 30, 2024

Thanks for opening this issue. A GitHub docs team member should be by to give feedback soon. In the meantime, please check out the contributing guidelines.

@github-actions github-actions bot added the triage Do not begin working on this issue until triaged by the team label Aug 30, 2024
@nguyenalex836 nguyenalex836 added actions This issue or pull request should be reviewed by the docs actions team waiting for review Issue/PR is waiting for a writer's review and removed triage Do not begin working on this issue until triaged by the team labels Aug 30, 2024
@nguyenalex836
Copy link
Contributor

@lfdominguez Thank you for opening an issue! I'll get this triaged for review ✨

@hsnabszhdn
Copy link
Contributor

It applies to all notice, warning and error workflow commands (in all of them title is mentioned as required).

@subatoi
Copy link
Contributor

subatoi commented Sep 2, 2024

Thanks for raising an issue, @lfdominguez! We really appreciate you doing that before raising a PR.

I agree with you and @hsnabszhdn: either of you (or anyone else) is welcome to open a PR to change the examples on the page for the notice, warning and error workflow commands to include title fields. Please use our placeholder format as follows:

title=YOUR-TITLE

I'll open this issue up as help wanted. Thanks again!

@subatoi subatoi added the help wanted Anyone is welcome to open a pull request to fix this issue label Sep 2, 2024
@lfdominguez
Copy link
Contributor Author

Thanks... when come back to home i will open the PR.

@rona901

This comment was marked as spam.

@rona901

This comment was marked as spam.

@nguyenalex836 nguyenalex836 removed the waiting for review Issue/PR is waiting for a writer's review label Sep 2, 2024
@hsnabszhdn
Copy link
Contributor

The thing is that title is NOT required 😕

image

Maybe the table should be updated?

image

@nguyenalex836
Copy link
Contributor

The thing is that title is NOT required 😕
Maybe the table should be updated?

@hsnabszhdn Thank you for the ping on this! Going to loop in @subatoi to help determine the best path forward 💛

@subatoi
Copy link
Contributor

subatoi commented Sep 3, 2024

Thanks for your help @hsnabszhdn, and thanks for raising a PR as requested, @lfdominguez — apologies about the confusion here as quite clearly something's gone wrong.

@nguyenalex836 I'd suggest we check in with an SME internally (so I've added the appropriate label) just to make 100% sure. Let's also put #34465 on hold for now. Once we've figured out the best change to make, we can make sure a PR is merged with appropriate co-committer attribution, because clearly we do need to make a change here.

@subatoi subatoi added the needs SME This proposal needs review from a subject matter expert label Sep 3, 2024
Copy link
Contributor

github-actions bot commented Sep 3, 2024

Thanks for opening an issue! We've triaged this issue for technical review by a subject matter expert 👀

@nguyenalex836 nguyenalex836 removed the help wanted Anyone is welcome to open a pull request to fix this issue label Sep 5, 2024
@nguyenalex836
Copy link
Contributor

@hsnabszhdn Thank you for your patience while we checked with our SME team! You were absolutely correct 💛 title is not required, and we are updating the table internally to reflect this (you've been added as a co-committer on that PR ✨). Thank you very much for catching that error!

@lfdominguez thank you again for your willingness to contribute to your community, and bearing with us as we investigated! 🙇

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
actions This issue or pull request should be reviewed by the docs actions team content This issue or pull request belongs to the Docs Content team needs SME This proposal needs review from a subject matter expert
Projects
None yet
Development

No branches or pull requests

5 participants