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

Naming rule of CI jobs is not consistent #5264

Closed
nzw0301 opened this issue Feb 22, 2024 · 0 comments
Closed

Naming rule of CI jobs is not consistent #5264

nzw0301 opened this issue Feb 22, 2024 · 0 comments
Labels
feature Change that does not break compatibility, but affects the public interfaces.

Comments

@nzw0301
Copy link
Member

nzw0301 commented Feb 22, 2024

Motivation

Github CI job names are categorised into two groups:

  1. Names starting with capital letter:
.github/workflows/coverage.yml:name: Coverage
.github/workflows/checks.yml:name: Checks
.github/workflows/speed-benchmarks.yml:name: Speed benchmarks
.github/workflows/performance-benchmarks-naslib.yml:name: Performance Benchmarks with NASLib
.github/workflows/tests-integration.yml:name: Tests (Integration)
.github/workflows/pypi-publish.yml:name: Publish distributions to PyPI or TestPyPI
.github/workflows/tests-storage.yml:name: Tests (Storage with server)
.github/workflows/performance-benchmarks-bayesmark.yml:name: Performance benchmarks with bayesmark
.github/workflows/tests.yml:name: Tests
.github/workflows/performance-benchmarks-mo-kurobako.yml:name: Performance Benchmarks with kurobako for multi-objective optimization
.github/workflows/tests-with-minimum-versions.yml:name: Tests with minimum versions
.github/workflows/checks-integration.yml:name: Checks (Integration)
.github/workflows/sphinx-build.yml:name: Sphinx
.github/workflows/reviewdog.yml:name: Reviewdog
.github/workflows/dockerimage.yml:name: Build Docker Image
.github/workflows/performance-benchmarks-kurobako.yml:name: Performance Benchmarks with kurobako
  1. Names starting with non capital letter and using - instead of :
.github/workflows/mac-tests.yml:name: mac-tests
.github/workflows/windows-tests.yml:name: windows-tests
.github/workflows/stale.yml:name: stale

I believe that unifying names makes the reviewers more developer-friendly. letters

Description

Rename the second group to match the first group naming rule.

Alternatives (optional)

No response

Additional context (optional)

No response

@nzw0301 nzw0301 added the feature Change that does not break compatibility, but affects the public interfaces. label Feb 22, 2024
@nzw0301 nzw0301 closed this as completed Apr 3, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
feature Change that does not break compatibility, but affects the public interfaces.
Projects
None yet
Development

No branches or pull requests

1 participant