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

Change a behavior when run `rake generate_cops_documentation` with CI #4865

Conversation

Projects
None yet
2 participants
@koic
Copy link
Member

commented Oct 16, 2017

It is a similar change to #4805.

I found it in the following log of Travis CI.
https://travis-ci.org/bbatsov/rubocop/jobs/282028577#L612-L625

This PR changes the behavior when manual is out of synchronized
when run rake generate_cops_documentation with CI.

Before

% bundle exec rake generate_cops_documentation

(snip)

rake aborted!
The manual directory is out of sync. Run rake
generate_cops_documentation and commit the results.
tasks/cops_documentation.rake:166:in `block in
assert_manual_synchronized'
tasks/cops_documentation.rake:160:in `assert_manual_synchronized'
tasks/cops_documentation.rake:182:in `block in <top (required)>'
/Users/koic/.rbenv/versions/2.4.2/bin/bundle:23:in `load'
/Users/koic/.rbenv/versions/2.4.2/bin/bundle:23:in `<main>'
Tasks: TOP => generate_cops_documentation
(See full trace by running task with --trace)

After

% bundle exec rake generate_cops_documentation

(snip)

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

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).
  • Used the same coding conventions as the rest of the project.
  • 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.
  • All tests(rake spec) are passing.
  • The new code doesn't generate RuboCop offenses that are checked by rake internal_investigation.
  • The PR relates to only one subject with a clear title
    and description in grammatically correct, complete sentences.
  • Updated cop documentation with rake generate_cops_documentation (required only when you've added a new cop or changed the configuration/documentation of an existing cop).
Change a behavior when run `rake generate_cops_documentation` with CI
It is a similar change to #4805.

I found it in the following log of Travis CI.
https://travis-ci.org/bbatsov/rubocop/jobs/282028577#L612-L625

This commit changes the behavior when manual is out of synchronized
when run `rake generate_cops_documentation` with CI.

Before
======

```console
% bundle exec rake generate_cops_documentation

(snip)

rake aborted!
The manual directory is out of sync. Run rake
generate_cops_documentation and commit the results.
tasks/cops_documentation.rake:166:in `block in
assert_manual_synchronized'
tasks/cops_documentation.rake:160:in `assert_manual_synchronized'
tasks/cops_documentation.rake:182:in `block in <top (required)>'
/Users/koic/.rbenv/versions/2.4.2/bin/bundle:23:in `load'
/Users/koic/.rbenv/versions/2.4.2/bin/bundle:23:in `<main>'
Tasks: TOP => generate_cops_documentation
(See full trace by running task with --trace)
```

After
=====

```console
% bundle exec rake generate_cops_documentation

(snip)

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

@bbatsov bbatsov merged commit 3d63dca into rubocop-hq:master Oct 16, 2017

2 checks passed

continuous-integration/appveyor/pr AppVeyor build succeeded
Details
continuous-integration/travis-ci/pr The Travis CI build passed
Details
@bbatsov

This comment has been minimized.

Copy link
Collaborator

commented Oct 16, 2017

👍

@koic koic deleted the koic:change_behavior_when_run_generate_cops_documentation branch Oct 16, 2017

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
You can’t perform that action at this time.