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.

Sign up for GitHub

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

Jump to bottom

Add a Release.md #16

Merged
merged 3 commits into from
Oct 22, 2019
Merged

Add a Release.md #16

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
e1706be
Release.md
adamkhazi Oct 22, 2019
f8c745e
Release.md minor
adamkhazi Oct 22, 2019
ed6cb16
bash command coloring
adamkhazi Oct 22, 2019
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
13 changes: 13 additions & 0 deletions Release.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
# Release Process

1. Bump the version number in [Makefile](/Makefile)
2. Run `make update_version` to update version references in various source and markdown files
3. Make a pull request with the changes
4. Once merged, [draft a new release](https://github.com/bloomberg/xcdiff/releases/new)
5. Tag the release with the appropriate version
6. Use the version number as the release title
7. Populate the description with the recent changes since the last release. For convenience the following command can be used to generate a changelog summary:

```bash
git log master...$(git describe --tags `git rev-list --tags --max-count=1`) --pretty=format:'- %s'
```