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

Update README to specify tag requirements #25

Merged
merged 2 commits into from
Jan 24, 2017
Merged

Update README to specify tag requirements #25

merged 2 commits into from
Jan 24, 2017

Conversation

MartinSnyder
Copy link
Contributor

Hi Dale,

Didn't take me long to figure this out, but I thought I'd leave this breadcrumb for future users so they don't get confused about how to get sbt-dynver to recognize tags.

Copy link
Member

@dwijnand dwijnand left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You're right, this is important information we should state upfront clearly. I have some small modifications if you wouldn't mind. Otherwise I can do them post-merge. Thank you.

## Tag Requirements

In order to be recognized by sbt-dynver, tags must meet the following two requirements:
1. Must be an annotated tag (as opposed to a lightweight tag)
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The requirement that tags must be annotated/non-lightweight was actually lifted in v1.1.0, see #15. So can I ask you to remove this line please?


In order to be recognized by sbt-dynver, tags must meet the following two requirements:
1. Must be an annotated tag (as opposed to a lightweight tag)
2. Must begin with the letter 'v'
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Let's be really specific :) It must begin with the letter 'v' and a digit: v[0-9].


If you're not seeing what you expect, then start with this:

git tag -af v0.0.1 -m "Initial version tag for sbt-dynver"
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Real, real nitpick: could you drop the -f :)

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'll make these revisions, no problem. Thanks for the additional detail.

@dwijnand dwijnand merged commit ec33260 into sbt:master Jan 24, 2017
@dwijnand
Copy link
Member

Thanks @MartinSnyder.

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.

None yet

2 participants