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

Align the Configuration reference documentation with the code #2914

Conversation

chris-codeflow
Copy link
Contributor

@chris-codeflow chris-codeflow commented Nov 10, 2021

Description

  • Aligned the configuration defaults with the code
  • Added missing fields
  • Fixed typos

Related Issue

Closes #2913

Motivation and Context

My motivation for submitting this PR was due to when I found that GitVersion was using a pre-release label (tag) of alpha when calculating the SemVer in a develop branch, but the reference documentation stated the pre-release label should be unstable. After checking the latest source code in the main branch, I found that the documentation was not fully aligned with the source code.

How Has This Been Tested?

Triple-checked the changes against the source code.

Screenshots (if appropriate):

N/A

Checklist:

  • My code follows the code style of this project.
  • [] My change requires a change to the documentation.
  • I have updated the documentation accordingly.
  • I have added tests to cover my changes.
  • All new and existing tests passed.

@arturcic arturcic requested a review from asbjornu November 11, 2021 06:30
Copy link
Member

@asbjornu asbjornu left a comment

Choose a reason for hiding this comment

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

Thanks for tidying up everything! I just have a few comments and suggestions.

docs/input/docs/reference/configuration.md Outdated Show resolved Hide resolved
docs/input/docs/reference/configuration.md Outdated Show resolved Hide resolved
docs/input/docs/reference/configuration.md Outdated Show resolved Hide resolved
docs/input/docs/reference/configuration.md Outdated Show resolved Hide resolved
@asbjornu asbjornu enabled auto-merge November 11, 2021 10:39
Copy link
Member

@gep13 gep13 left a comment

Choose a reason for hiding this comment

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

LGTM!

@asbjornu asbjornu disabled auto-merge November 11, 2021 12:27
@asbjornu asbjornu merged commit 15da5ed into GitTools:main Nov 11, 2021
@arturcic arturcic added this to the 5.8.0 milestone Nov 11, 2021
@mergify
Copy link
Contributor

mergify bot commented Nov 11, 2021

Thank you @chris-codeflow for your contribution!

@arturcic arturcic removed this from the 5.8.0 milestone Nov 11, 2021
@chris-codeflow chris-codeflow deleted the feature/Align-configuration-reference-doc-with-code branch November 11, 2021 12:29
@chris-codeflow
Copy link
Contributor Author

When does the https://gitversion.net site get synced with the published documentation @asbjornu or @arturcic?

@arturcic
Copy link
Member

It should be published on next planned release

@arturcic arturcic modified the milestone: 5.8.0 Nov 12, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[Improvement] Align the Configuration reference documentation with the code
4 participants