The .github/workflows folder is inconsistent with the filenames inside it. We have some mix of kebab-case and snake_case.
stoyan @ zenbook: ~/open-source/checkstyle/.github/workflows master [↑]
$ ls 10:38:44 pm
actionlint.bak codeql-analysis.yml new-milestone-and-issue-in-other-repo.yml publish_releasenotes_outside.yml site.yml
bump_license_year.yml copy_site_to_sourceforge.yml no-exception-workflow.yml rebase.yml update_github_io.yml
bump-version-and-update-milestone.yml diff_report.yml no_old_refs.yml releasenotes-gen.yml update_sources.yml
checker-framework.yml error-prone.yml pitest.yml run_link_check.yml upload-all-jar.yml
check-pr-description.yml maven_prepare.yml publish_releasenotes_for_twitter.yml shellcheck.yml
I noticed GitHub uses kebab-case in their GitHub Actions documentation, but some people suggest depending on the surrounding software so that would be PascalCase in checkstyle's case? For me, it doesn't matter as long as it's consistent.
Further edit:
Since we are covering
We should use kebab-case for naming of scripts or configs.
we include the scripts in the .ci folder as well.
Folders to cover
The
.github/workflowsfolder is inconsistent with the filenames inside it. We have some mix ofkebab-caseandsnake_case.I noticed GitHub uses
kebab-casein their GitHub Actions documentation, but some people suggest depending on the surrounding software so that would bePascalCasein checkstyle's case? For me, it doesn't matter as long as it's consistent.Further edit:
Since we are covering
we include the scripts in the
.cifolder as well.Folders to cover
.ci.github/workflowsconfig