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

Clarify, or link to, info about filenames #64

Open
marcoscaceres opened this issue May 26, 2021 · 3 comments
Open

Clarify, or link to, info about filenames #64

marcoscaceres opened this issue May 26, 2021 · 3 comments
Labels
documentation Improvements or additions to documentation

Comments

@marcoscaceres
Copy link
Member

The examples have different filenames (pr.yml, pr-push.yml) - presumedly, they have special meaning/side-effects.

It be great if the doc explained when to use which or pointed so some resource that explained those (or just chose the safest default one).

@sidvishnoi sidvishnoi added the documentation Improvements or additions to documentation label May 26, 2021
@marcoscaceres
Copy link
Member Author

marcoscaceres commented May 28, 2021

So, turns out the filename is meaningless, right? We (@plehegar and I) searched for uses of "spec-prod" action and found they use a bunch of different filenames.

I think "pr-push.yml" was the most popular. I'm still personally worried that this will confuse people (like me! I was already confused as I thought the name meant something).

I can live with "pr-push.yml" as the default one we use everywhere... but maybe a generic "action.yml" would be better, given how it behaves is defined in the .yml itself, and not related to the filename.

@sidvishnoi
Copy link
Member

Should add a link to GitHub workflow syntax for details (missed in #69).

@marcoscaceres
Copy link
Member Author

We are going with auto-publish.yml everywhere, but we should at least mention that the name is meaningless but we use it (or will use it) at the W3C to know if a spec is auto-published or not.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

2 participants