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

Make releases less noisy #1392

Open
troessner opened this issue Jul 10, 2018 · 3 comments
Open

Make releases less noisy #1392

troessner opened this issue Jul 10, 2018 · 3 comments
Labels

Comments

@troessner
Copy link
Owner

Since we are explicitly putting version numbers in our documentation links our releases have become very noisy as you can see in #1391.
Ideally, there would be one cucumber feature that ensures that our links change as well with new versions and that would then cause a one line change per new version release.

@mvz
Copy link
Collaborator

mvz commented Jul 10, 2018

Agreed. Perhaps we can add some interpolation in the expected strings in the feature files.

@eloyesp
Copy link

eloyesp commented May 6, 2019

As documentation is bundled with the gem, links could point to the local filesystem, that way you don't need github nor version number and also don't need internet.

The documentation can also be provided inline (with a flag or may be a custom command).

app/controllers/users_controller.rb -- 33 warnings:
  [48, 50, 54, 56]:DuplicateMethodCall: UsersController#add_admin_role calls '@user.name' 4 times [ reek doc duplicate_method_call ]

$ reek doc duplicate_method_call
# Duplicate Method Call

Markdown here

@troessner
Copy link
Owner Author

That is a very good idea, thank you for that :)
We might come back to this in the future.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

3 participants