Update documentation for GitHub Workflow Status Badges

[calebcartwright]

Our GitHub Workflow Status badges use an upstream GitHub API endpoint that requires we utilize the Workflow name. GitHub provides native badges for Workflow status which requires users specify the file name that contains the workflow definition.

For one reason or another, many of our users assume that Shields also wants the file name parameter, and are then confused when our badges show 404/not found type messages (e.g. #6593, #6255)

I anticipate this will continue to be a recurrent issue for some, but it'd likely help avoid some confusion if we extended the modal badge window documentation for these badges to stress this. We could consider changing the parameter name to something more explicit too (e.g. workflow --> workflowName).

The text that displays is configured via the documentation key on each example in the service class definition, some of the example listings for the Worklow Status badge class linked below for reference. We have a default documentation value for all our GitHub badges, so any updates/augmentation we make to the Workflow badge examples would need to be an extension that retained the standard GitHub help text and added additional info

shields/services/github/github-workflow-status.service.js

Lines 27 to 56 in 4ad822c

	static examples = [
	{
	title: 'GitHub Workflow Status',
	pattern: ':user/:repo/:workflow',
	namedParams: {
	user: 'actions',
	repo: 'toolkit',
	workflow: 'toolkit-unit-tests',
	},
	staticPreview: renderBuildStatusBadge({
	status: 'passing',
	}),
	documentation,
	keywords,
	},
	{
	title: 'GitHub Workflow Status (branch)',
	pattern: ':user/:repo/:workflow/:branch',
	namedParams: {
	user: 'actions',
	repo: 'toolkit',
	workflow: 'toolkit-unit-tests',
	branch: 'master',
	},
	staticPreview: renderBuildStatusBadge({
	status: 'passing',
	}),
	documentation,
	keywords,
	},

[chrysillala]

Hi @calebcartwright I would like to work on this issue, could you provide more details? Thanks!

[calebcartwright]

hi @chrysillala, that'd be great!

could you provide more details?

I feel like the issue description is already very thorough, and provides both a direct link to the location in code where the change would be made as well as the additional information that needs to be added. I'm not really sure what else I could add to that without practically writing the code myself 😄

Do you have any specific questions or find anything unclear?

[ppizarror]

Hi, I had the same problem. From the hints provided on the website, I thought the name was the same as the .yml file (same as #6593, #6255). Maybe a hint or further explanation might work.

[aditya1abhinav]

Hi @calebcartwright I would like to work on this issue.

[chris48s]

This one will become irrelevant if we merge #8475
I think its best we ignore it for now as it will hopefully become a non-issue.

[chris48s]

This is now irrelevant due to #8671