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

First draft for an automatic README.md version update #217

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

muuki88
Copy link

@muuki88 muuki88 commented Jan 1, 2018

Hi,

This PR is a draft for the following feature:

Automatically update the version defined in the README.md to the released version

This is implemented via two additional release steps:

  1. updateReadme
  2. commitReadme

The implementation is yet missing some crucial parts

  • configurable regex to find the version definition
  • configurable README.md file ( necessary ? )
  • documentation

WDYT?

@raboof
Copy link

raboof commented Jan 24, 2018

I'm not sure about the implementation (I'm not familiar with sbt-release internals, and the version regex seems to be a bit dangerous: that might also match non-versions or versions of other software also mentioned in the README). Perhaps it should be restricted to specific patterns (e.g. ship with patterns for sbt/maven/gradle dependency examples that match artifact names being released, extensible by users of the plugin?)

Nonetheless this would indeed be a super useful feature!

@muuki88
Copy link
Author

muuki88 commented Feb 16, 2018

Thanks a lot for your feedback :)

the version regex seems to be a bit dangerous: that might also match non-versions or versions of other software also mentioned in the README

This is absolutely true. For this reason I want to make it configurable, so every user can tailor it to its needs.

Perhaps it should be restricted to specific patterns (e.g. ship with patterns for sbt/maven/gradle dependency examples that match artifact names being released

Shipping a bunch of commonly used patterns could be a nice addition in another pull request.

@vladimir-popov
Copy link

any updates?

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.

3 participants