Skip to content

Fixing comments from previous PR review #459

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

Merged
merged 1 commit into from
Jun 9, 2015
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion Docs/configurationOptions.md
Original file line number Diff line number Diff line change
@@ -1 +1 @@
# Confiuration options
# Configuration options
7 changes: 1 addition & 6 deletions Docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,11 +4,6 @@ GitVersion is a tool to help you achieve Semantic Versioning on your project.
This influences many of the decisions GitVersion has made, please read and understand this page as it will help you start using GitVersion effectively!

## Assumptions/Rules
### You tag releases when you release, not before
GitVersion assumes that tags are used to *tag a release* and not used to build a release.

This means that the version is calculated pre-emptively, if you currently tag, build then release that tag then GitVersion will probably not work for you.

### Tags override other rules
If a commit is tagged, then GitVersion will *always* use that version over any calculated versions. This is so if you rebuild a tag then the same version will be produced.

Expand Down Expand Up @@ -39,6 +34,6 @@ We recognise that a single formatted version number does not work for all cases.
You can just run `GitVersion.exe` in your repository to see what variables are available (by default a json object is returned).

## Exe or MSBuild Task
There are two ways to consume GitVersion, the first is by running GitVersion.exe. The second is an MSBUild task. The MSBuild task is really easy to get up and running, simply install GitVersionTask from NuGet and it will integrate into your project and write out variables to your build server if it's running on one. The exe offers more options and works for not just .net projects.
There are two ways to consume GitVersion, the first is by running GitVersion.exe. The second is an MSBuild task. The MSBuild task is really easy to get up and running, simply install GitVersionTask from NuGet and it will integrate into your project and write out variables to your build server if it's running on one. The exe offers more options and works for not just .net projects.

Read more about [using GitVersion](./usage.md)
4 changes: 2 additions & 2 deletions Docs/versionSources.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ GitVersion will find all tags on the current branch and return the highest one.
Will increment: true

### Version in branch name
If the branch has a version in it, then that version will be returned
If the branch has a version in it, then that version will be returned.

Will increment: false

Expand All @@ -27,7 +27,7 @@ If a branch with a version number in it is merged into the current branch, that
Will increment: false

### GitVersionConfig.yaml
If the next-version property is specified in the config file, it will be used as a version source.
If the `next-version` property is specified in the config file, it will be used as a version source.

Will increment: false

Expand Down
2 changes: 1 addition & 1 deletion GitVersionCore/Configuration/Wizard/EditConfigStep.cs
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ protected override string GetPrompt(Config config)
{
return string.Format(@"Which would you like to change?

0) Save changes
0) Save changes and exit
1) Exit without saving
2) Branch specific configuration
3) Branch Increment mode (per commit/after tag) (Current: {0})
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ protected override string GetPrompt(Config config)
{
return @"GitVersion can try to recommend you a branching strategy based on a few questions.

Do you need to maintain mutliple versions of your application simultanously in production? (y/n)";
Do you need to maintain multiple versions of your application simultaneously in production? (y/n)";
}

protected override string DefaultResult
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,9 +13,9 @@ protected override StepResult HandleResult(string result, Queue<ConfigInitWizard
Console.WriteLine("GitFlow is likely a good fit, the 'develop' branch can be used " +
"for active development while stabilising the next release.");
Console.WriteLine();
Console.WriteLine("GitHubFlow is designed for a lightwieght workflow where master is always " +
Console.WriteLine("GitHubFlow is designed for a lightweight workflow where master is always " +
"good to deploy to production and feature branches are used to stabilise " +
"features, once stable they can be released in the next release");
"features, once stable they are merged to master and made available in the next release");
steps.Enqueue(new PickBranchingStrategyStep());
return StepResult.Ok();
case "n":
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ protected override StepResult HandleResult(string result, Queue<ConfigInitWizard
Console.WriteLine("GitFlow could be a better fit than GitHubFlow for you.");
Console.WriteLine();
Console.WriteLine("GitVersion increments the SemVer for each commit on the develop branch by default, " +
"this means all packages build from develop can be published to a single NuGet feed.");
"this means all packages built from develop can be published to a single NuGet feed.");
break;
case "n":
Console.WriteLine("We recommend the GitHubFlow branching strategy, it sounds like you will " +
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ protected override StepResult HandleResult(string result, Queue<ConfigInitWizard

protected override string GetPrompt(Config config)
{
return string.Format(@"What do you want the increment mode for {0} to be
return string.Format(@"What do you want the increment mode for {0} to be?

0) Back
1) Follow SemVer and only increment when a release has been tagged (continuous delivery mode)
Expand Down
2 changes: 1 addition & 1 deletion GitVersionCore/Configuration/Wizard/SetBranchTag.cs
Original file line number Diff line number Diff line change
Expand Up @@ -9,8 +9,8 @@ public class SetBranchTag : ConfigInitWizardStep

public SetBranchTag(string name, BranchConfig branchConfig)
{
this.branchConfig = branchConfig;
this.name = name;
this.branchConfig = branchConfig;
}

protected override StepResult HandleResult(string result, Queue<ConfigInitWizardStep> steps, Config config)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ protected override StepResult HandleResult(string result, Queue<ConfigInitWizard

protected override string GetPrompt(Config config)
{
return "Would you like to run an extended init (more like a tutorial) (y/n)";
return "Would you like to run an extended init? (more like a tutorial) (y/n)";
}

protected override string DefaultResult
Expand Down