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

[18-stable] Migrate from Chefstyle to Cookstyle gem #1834

Merged
merged 1 commit into from
Aug 13, 2024
Merged

[18-stable] Migrate from Chefstyle to Cookstyle gem #1834

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
2 changes: 1 addition & 1 deletion .github/workflows/lint.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,4 +20,4 @@ jobs:
ruby-version: 2.7
bundler-cache: true
- uses: r7kamura/rubocop-problem-matchers-action@v1 # this shows the failures in the PR
- run: bundle exec chefstyle
- run: bundle exec rake style
2 changes: 1 addition & 1 deletion Gemfile
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ gem "chef-utils", git: "https://github.com/chef/chef", branch: "chef-18", glob:

# NOTE: do not submit PRs to add pry as a dep, add to your Gemfile.local
group :development do
gem "chefstyle", "2.2.2"
gem "cookstyle", ">= 7.32.8"
gem "ipaddr_extensions"
gem "rake", ">= 10.1.0"
gem "rspec-collection_matchers", "~> 1.0"
Expand Down
2 changes: 1 addition & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ bundle exec rspec spec/unit/FILE.rb

## Style

We use [Chefstyle](https://github.com/chef/chefstyle), as a code [linter](https://en.wikipedia.org/wiki/Lint_(software)), to enforce style guidelines. To run:
We use [Cookstyle](https://github.com/chef/cookstyle), as a code [linter](https://en.wikipedia.org/wiki/Lint_(software)), to enforce style guidelines. To run:

```
bundle exec rake style
Expand Down
4 changes: 2 additions & 2 deletions Rakefile
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,14 +16,14 @@ rescue LoadError
end

begin
require "chefstyle"
require "cookstyle/chefstyle"
require "rubocop/rake_task"
desc "Run Chefstyle tests"
RuboCop::RakeTask.new(:style) do |task|
task.options += ["--display-cop-names", "--no-color"]
end
rescue LoadError
puts "chefstyle gem is not installed. bundle install first to make sure all dependencies are installed."
puts "cookstyle gem is not installed. bundle install first to make sure all dependencies are installed."
end

task :console do
Expand Down