Skip to content

ci: Run performance and layout checks in RuboCop #2173

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

Draft
kaylareopelle wants to merge 5 commits into
base: main
Choose a base branch
from
+8 −1
Draft

ci: Run performance and layout checks in RuboCop #2173

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
5cfcc72
ci: Run performance and layout checks in RuboCop
kaylareopelle Apr 7, 2026
5c3f733
Add check:performance:ruby to check script
kaylareopelle Apr 7, 2026
87cdb6d
Remove unnecessary layout check
kaylareopelle Apr 7, 2026
d47dea0
Merge branch 'main' into rubocop-performance-layout
thompson-tomo Apr 18, 2026
4001bd7
merge fix
thompson-tomo Apr 18, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions .github/workflows/ci-markdown-checks.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -114,6 +114,11 @@ jobs:
set -e # forces exit code to propagate
npm run check:source:ruby -- --format github

- name: "Check all ruby files for performance"
run: |
set -e # forces exit code to propagate
npm run check:performance:ruby -- --format github

yaml-lint-check:
if: ${{ github.repository == 'open-telemetry/opentelemetry-ruby-contrib' }}
name: YAML Lint Check
Expand Down
4 changes: 3 additions & 1 deletion package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"scripts": {
"check": "npm run check:lint && npm run check:format && npm run check:links && npm run check:spelling && npm run check:source",
"check": "npm run check:lint && npm run check:format && npm run check:links && npm run check:performance:ruby && npm run check:spelling && npm run check:source",
"check:format": "npm run check:format:ruby && prettier . --check",
"check:format:json": "prettier **/*.json --check",
"check:format:markdown": "prettier **/*.md --check",
Expand All @@ -11,6 +11,7 @@
"check:lint:markdown": "markdownlint-cli2 '**/*.md'",
"check:lint:renovate": "renovate-config-validator",
"check:lint:ruby": "rubocop --only Lint,Naming,Style",
"check:performance:ruby": "rubocop --only Performance",
Copy link
Copy Markdown
Contributor

@thompson-tomo thompson-tomo Apr 7, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We should also have a write command.

And also add performance to both the check & write command.

Copy link
Copy Markdown
Contributor Author

@kaylareopelle kaylareopelle Apr 7, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What do you think about adding performance to one of the existing checks rather than making it its own check? We don't have anything other performance checking tools to group it with. Could it fit with check:source:ruby?

Copy link
Copy Markdown
Contributor

@thompson-tomo thompson-tomo Apr 7, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sure that works for me.

"check:source": "npm run check:source:ruby",
"check:source:ruby": "rubocop --only Bundler,Gemspec,Metrics,Migration,Minitest,Performance,Rake,RSpec,Security",
"check:spelling": "cspell -c .cspell.yml .",
Expand All @@ -23,6 +24,7 @@
"write:lint:json": "uname >/dev/null 2>&1 && jsonlint --config .jsonlintrc.yml --in-place && npm run write:format:json || true",
"write:lint:markdown": "markdownlint-cli2 '**/*.md' --fix && npm run write:format:markdown",
"write:lint:ruby": "npm run check:lint:ruby -- --autocorrect-all",
"write:performance:ruby": "npm run check:performance:ruby -- --autocorrect-all",
"write:source": "npm run write:source:ruby",
"write:source:ruby": "npm run check:source:ruby -- --autocorrect-all"
},
Expand Down
Loading