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.

Sign up for GitHub

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

Jump to bottom

Lowercase naming for GitHub Action workflows #36

Closed
svengreb opened this issue Aug 29, 2020 · 0 comments · Fixed by #37
Closed

Lowercase naming for GitHub Action workflows #36

svengreb opened this issue Aug 29, 2020 · 0 comments · Fixed by #37
Labels
context-workflow scope-compatibility scope-quality scope-stability target-base type-improvement
Milestone
0.2.0

Comments

@svengreb
Copy link
Owner

svengreb commented Aug 29, 2020 •
edited
Loading

Even though it is possible to use uppercase names (including whitespaces) for GitHub Action workflows it is best practice for almost every language to use lowercase names. This prevents problems with parsing as well as errors due to lower- and uppercase mismatches.

One example is the shields.io SVG badge that is used in the README of this repository: The actual workflow is only found when the name matches the exact notation including lower- and uppercase characters:

- https://img.shields.io/github/workflow/status/svengreb/tmpl/ci.svg
+ https://img.shields.io/github/workflow/status/svengreb/tmpl/CI.svg

To mitigate such problems the name should be changed to lowercase only.
@svengreb svengreb added this to the Next milestone Aug 29, 2020
@svengreb svengreb self-assigned this Aug 29, 2020
@svengreb svengreb changed the title Use lowercase naming for GitHub Action workflows Lowercase naming for GitHub Action workflows Aug 29, 2020
svengreb added a commit that referenced this issue Aug 29, 2020
@svengreb
Lowercase naming for GitHub Action workflows
97c774d 
Even though it is possible to use uppercase names (including
whitespaces) for GitHub Action workflows it is best practice for almost
every language to use lowercase names. This prevents problems with
parsing as well as errors due to lower- and uppercase mismatches.

One example is the shields.io [1] SVG badge that is used in the README
of this repository: The actual workflow is only found when the name
matches the exact notation including lower- and uppercase characters:

```diff
- https://img.shields.io/github/workflow/status/svengreb/tmpl/ci.svg
+ https://img.shields.io/github/workflow/status/svengreb/tmpl/CI.svg
```

To mitigate such problems the name has been changed to lowercase only.

[1]: https://shields.io

GH-36
@svengreb svengreb mentioned this issue Aug 29, 2020
Merged
svengreb added a commit that referenced this issue Aug 29, 2020
@svengreb
Lowercase naming for GitHub Action workflows (#37)
e53fbaf 
Even though it is possible to use uppercase names (including
whitespaces) for GitHub Action workflows it is best practice for almost
every language to use lowercase names. This prevents problems with
parsing as well as errors due to lower- and uppercase mismatches.

One example is the shields.io [1] SVG badge that is used in the README
of this repository: The actual workflow is only found when the name
matches the exact notation including lower- and uppercase characters:

```diff
- https://img.shields.io/github/workflow/status/svengreb/tmpl/ci.svg
+ https://img.shields.io/github/workflow/status/svengreb/tmpl/CI.svg
```

To mitigate such problems the name has been changed to lowercase only.

[1]: https://shields.io

Closes GH-36
@svengreb svengreb removed their assignment Aug 29, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
context-workflow scope-compatibility scope-quality scope-stability target-base type-improvement
Projects
None yet
Milestone
0.2.0
Development

Successfully merging a pull request may close this issue.

Lowercase naming for GitHub Action workflows svengreb/tmpl
1 participant
@svengreb