Skip to content
New issue

Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? # to your account

Lowercase naming for GitHub Action workflows #37

Merged
merged 1 commit into from
Aug 29, 2020

Conversation

svengreb
Copy link
Owner

Resolves #36

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 added this to the Next milestone Aug 29, 2020
@svengreb svengreb self-assigned this Aug 29, 2020
@svengreb svengreb merged commit e53fbaf into main Aug 29, 2020
@svengreb svengreb deleted the improvement/gh-36-lowercase-naming-action-workflows branch August 29, 2020 09:08
@svengreb svengreb removed their assignment Aug 29, 2020
# for free to join this conversation on GitHub. Already have an account? # to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Lowercase naming for GitHub Action workflows
1 participant