Skip to content

Workaround for broke CI with YARD 0.9.20#169

Merged
koic merged 1 commit intorubocop:masterfrom
koic:workaround_for_yard_0_9_20
Dec 7, 2019
Merged

Workaround for broke CI with YARD 0.9.20#169
koic merged 1 commit intorubocop:masterfrom
koic:workaround_for_yard_0_9_20

Conversation

@koic
Copy link
Member

@koic koic commented Dec 6, 2019

This PR solves the following "The manual directory is out of sync" error.

% ruby -v
ruby 2.7.0dev (2019-12-03T05:51:14Z master e42d9d8df8) [x86_64-darwin17]
% CI=true bundle exec rake

(snip)

The manual directory is out of sync. Run `rake
generate_cops_documentation` and commit the results.

https://circleci.com/gh/rubocop-hq/rubocop-rails/2180

This issue will be resolved with the release of YARD 0.9.21 or higher, which includes the following changes:
lsegal/yard#1290


Before submitting the PR make sure the following are checked:

  • Wrote good commit messages.
  • Commit message starts with [Fix #issue-number] (if the related issue exists).
  • Feature branch is up-to-date with master (if not - rebase it).
  • Squashed related commits together.
  • Added tests.
  • Added an entry to the Changelog if the new code introduces user-observable changes. See changelog entry format.
  • The PR relates to only one subject with a clear title
    and description in grammatically correct, complete sentences.
  • Run bundle exec rake default. It executes all tests and RuboCop for itself, and generates the documentation.

This PR solves the following "The manual directory is out of sync" error.

```console
% ruby -v
ruby 2.7.0dev (2019-12-03T05:51:14Z master e42d9d8df8) [x86_64-darwin17]
% CI=true bundle exec rake

(snip)

The manual directory is out of sync. Run `rake
generate_cops_documentation` and commit the results.
```

https://circleci.com/gh/rubocop-hq/rubocop-rails/2180

This issue will be resolved with the release of YARD 0.9.21 or higher,
which includes the following changes:
lsegal/yard#1290
@koic koic merged commit 1fc2d47 into rubocop:master Dec 7, 2019
@koic koic deleted the workaround_for_yard_0_9_20 branch December 7, 2019 17:28
@koic koic mentioned this pull request Dec 8, 2019
8 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant

Comments