simplycop 2.42.0 → 2.42.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 15025c48c319e254bf2a2a9ab8ce3046a0f3884265951ec4b1a910bc870d7ff1
4
- data.tar.gz: 1dfef42348722c0f3640a275e10f5a1666b2676979f208c06299203afa00a8d8
3
+ metadata.gz: eb25f96ac78cff744a69b8a59c401d35a912332b8ff46a8e4d70ecbbd5f417b1
4
+ data.tar.gz: 39a304d2fcb5a6e552e908d05e31e514170d3cfbfd4acf5f1c43d2510e41091c
5
5
  SHA512:
6
- metadata.gz: 04cc60d11999e3390cdc25a67b739bd0847ab929ade54c40244689c13309734627719547849872194b5a0e06118110c3d7f82b9ae1dfc5de104f0a4cc79d614b
7
- data.tar.gz: d9d0fc8dcabd8b57654b1c98fa0d522fefe2884188a9de523e2205a1344c95a2d0ab421e2c9e27fcbd3a33865d80a3f80d32314cec670cb33422b7281cbd279c
6
+ metadata.gz: d5d4f1d95416cd0720cff0efd4d906c43e2f6a4580cf80654f22b672e1be1dd38c0e6cd88bb2054a42875abf68bb1c3c59d921e1495d798da727c4011aee29e1
7
+ data.tar.gz: 6892eb7441bf17c44d08a344aba5960e0572885793ff72d5cc7c437a0070070a083d5bcd85818c907fce606fedf5f816e5da2052d2bfd489c8b0a606e43d57d5
@@ -40,8 +40,8 @@ jobs:
40
40
  gem-version: ${{ steps.version.outputs.version }}
41
41
  codacy-token: ${{ secrets.CODACY_TOKEN }}
42
42
  github-token: ${{ secrets.GITHUB_TOKEN }}
43
- dry-run: 'true'
44
- set-as-default: 'false'
43
+ dry-run: 'false'
44
+ set-as-default: 'true'
45
45
 
46
46
  - name: Print Summary
47
47
  env:
data/.simplycop_style.yml CHANGED
@@ -74,6 +74,8 @@ Style/CaseLikeIf:
74
74
  Style/CharacterLiteral:
75
75
  Enabled: true
76
76
 
77
+ # When enabled, this causes errors in Codacy after our config has been converted to their format.
78
+ # The problem is on their end and has not been resolved as of 17/2/26.
77
79
  Style/ClassAndModuleChildren:
78
80
  Enabled: false
79
81
 
data/docs/index.md CHANGED
@@ -306,7 +306,55 @@ If you prefer to manually version, you can do so by editing the `lib/simplycop/v
306
306
 
307
307
  ## Simplycop & Codacy
308
308
 
309
- Codacy's Rubocop configuration may not be fully up-to-date with Simplycop. Therefore you may find things pass in your local Simplycop run that then fail in the CI/CD pipeline. This will mainly be the case for newer cops that have been added. If this causes major issues for your PR, please consult engineering leads to arrange a Codacy override.
309
+ ### Codacy Integration Overview
310
+
311
+ Simplycop configurations are automatically synchronized with Codacy to ensure consistent code quality checks across the organization. This integration keeps Codacy's RuboCop analysis aligned with the latest Simplycop rules and configurations.
312
+
313
+ ### Pipeline Workflow
314
+
315
+ When a new version of Simplycop is released, the following automated process occurs:
316
+
317
+ 1. **Release Trigger**: The "Create GitHub Release" workflow completes successfully on the master branch
318
+ 2. **Delay Period**: A 20-second delay ensures the gem release is fully published and available
319
+ 3. **Version Extraction**: The pipeline extracts the new version number from `lib/simplycop/version.rb`
320
+ 4. **Codacy Update**: The `codacy-simplycop-update-action` is invoked to:
321
+ - Create or update a Codacy coding standard with the new Simplycop configuration
322
+ - Apply the patterns from the new version to all repositories
323
+ - Migrate repositories to use the new standard
324
+ - Disable any outdated Simplycop standards in Codacy
325
+ 5. **Summary Report**: A summary is generated showing:
326
+ - The Simplycop version deployed
327
+ - The coding standard name created
328
+ - Number of patterns applied
329
+ - Number of repositories migrated
330
+ - Number of old standards disabled
331
+
332
+ This automation ensures that all projects using Codacy for code quality checks will automatically receive the latest Simplycop rules without manual intervention.
333
+
334
+ ### Configuration Considerations
335
+
336
+ **RuboCop Version Compatibility**: Codacy's RuboCop container may lag behind the latest RuboCop version. This can occasionally cause:
337
+ - Warnings about deprecated configuration syntax (e.g., `require:` vs `plugins:` for extensions)
338
+ - Errors with newer configuration options not yet supported by Codacy's version
339
+
340
+ **Handling Codacy-Specific Issues**:
341
+
342
+ **Important**: Codacy ignores repository-specific RuboCop configuration, including local `.rubocop.yml` overrides and `.rubocop_todo.yml` files. This means code may pass locally but fail in the Codacy pipeline because:
343
+ - Rules you've disabled or overridden in your local configuration are still enforced by Codacy
344
+ - Violations listed in `.rubocop_todo.yml` are not ignored by Codacy
345
+ - Codacy uses only the centrally-managed Simplycop configuration
346
+
347
+ If you encounter issues where code passes locally but fails in Codacy:
348
+ 1. **Check for local overrides**: Review your `.rubocop.yml` and `.rubocop_todo.yml` for disabled cops or relaxed settings that Codacy doesn't respect
349
+ 2. **Fix violations**: Address the violations reported by Codacy, even if they're locally disabled
350
+ 3. **Request Codacy override**: If a rule causes significant issues across your project, consult engineering leads to arrange a Codacy-level override
351
+ 4. **Wait for updates**: For new Simplycop releases, the automatic Codacy update pipeline usually completes within minutes
352
+
353
+ ### Monitoring Updates
354
+
355
+ To track Codacy configuration updates:
356
+ - Check the [GitHub Actions workflow runs](https://github.com/simplybusiness/simplycop/actions/workflows/update-codacy.yml) for the "Update Codacy Configuration" workflow
357
+ - Review the workflow summary for details about applied patterns and migrated repositories
310
358
 
311
359
  ## FAQ
312
360
 
@@ -7,5 +7,5 @@
7
7
  #
8
8
 
9
9
  module Simplycop
10
- VERSION = '2.42.0'
10
+ VERSION = '2.42.1'
11
11
  end
metadata CHANGED
@@ -1,13 +1,13 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: simplycop
3
3
  version: !ruby/object:Gem::Version
4
- version: 2.42.0
4
+ version: 2.42.1
5
5
  platform: ruby
6
6
  authors:
7
7
  - Simply Business
8
8
  bindir: bin
9
9
  cert_chain: []
10
- date: 2026-02-16 00:00:00.000000000 Z
10
+ date: 2026-02-17 00:00:00.000000000 Z
11
11
  dependencies:
12
12
  - !ruby/object:Gem::Dependency
13
13
  name: benchmark