search

github / docs

The open-source repo for docs.github.com
https://docs.github.com
Creative Commons Attribution 4.0 International
16.08k stars 59.23k forks source link

Wrong ::warning example #34450

Open lfdominguez opened 2 weeks ago

lfdominguez commented 2 weeks ago

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

welcome[bot] commented 2 weeks ago

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.

nguyenalex836 commented 2 weeks ago

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

hsnabszhdn commented 2 weeks ago

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

subatoi commented 1 week ago

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!

lfdominguez commented 1 week ago

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

rona901 commented 1 week ago

He stole my ibnety guys . Help

rona901 commented 1 week ago

I'm from Israel he do bad things

hsnabszhdn commented 1 week ago

The thing is that title is NOT required 😕

image

Maybe the table should be updated?

image

nguyenalex836 commented 1 week ago

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 commented 1 week ago

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 https://github.com/github/docs/pull/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.

github-actions[bot] commented 1 week ago

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