Skip to content
This repository has been archived by the owner on Sep 20, 2022. It is now read-only.

grammar updates #122

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

grammar updates #122

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
12 changes: 6 additions & 6 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,9 +10,9 @@ GitReleaseNotes
[![Chocolatey](https://img.shields.io/chocolatey/v/gitreleasenotes.svg)](https://chocolatey.org/packages/GitReleaseNotes.Portable)
[![Build status](https://ci.appveyor.com/api/projects/status/br0rijb3rgn1qb0c/branch/master?svg=true)](https://ci.appveyor.com/project/GitTools/gitreleasenotes/branch/master)

Utility which makes it really easy to generate release notes for your Git project. Works with GitHub, Jira and YouTrack. TFS Support coming soon
Utility which makes it really easy to generate release notes for your Git project. Works with GitHub, Jira and YouTrack. TFS Support coming soon.

Have a look at the release notes in this Repo for a sample of what is generated by GitReleaseNotes
Have a look at the release notes in this Repo for a sample of what is generated by GitReleaseNotes.

## Install

Expand All @@ -31,17 +31,17 @@ This will write `ReleaseNotes.md` into the root of your repo, the release notes

- Use the git remote to connect to your issue tracker (if possible, i.e issue tracker is GitHub)
- Otherwise specify the issue tracker on the command line (`/IssueTracker Jira /JiraServer MyJiraServer` as well as project name, check `/?` for more info)
- Find closed issues since the last release and generate your release notes
- Use /allTags to generate complete release notes for all releases
- If the release notes are already generated, GitReleaseNotes will *append* **new** closed issues to your release notes, meaning all custom edits will be retained
- Find closed issues since the last release and generate your release notes.
- Use /allTags to generate complete release notes for all releases.
- If the release notes are already generated, GitReleaseNotes will *append* **new** closed issues to your release notes, meaning all custom edits will be retained.
- Writes out the release notes following [SemanticReleaseNotes.org](http://www.semanticreleasenotes.org/)

You can also use GitReleaseNotes to create a GitHub release, and generate the release notes automatically allowing fully automated releases including release notes generation.

If you use GitHub milestones to manage your releases [GitHubReleaseNotes](https://github.com/Particular/GitHubReleaseNotes) is a similar project.

## Versioning a release
[GitVersion](https://github.com/GitTools/GitVersion) is another project which can help you generate version numbers and make following Semantic Versions easily
[GitVersion](https://github.com/GitTools/GitVersion) is another project which can help you generate version numbers and make following Semantic Versions easily.

## Publishing a release
Initial versions of this tool allowed publishing to GitHub. This has been removed.
Expand Down