Skip to content

Add release documentation #1338

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 3 commits into from
Jul 6, 2018
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
26 changes: 26 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -68,3 +68,29 @@ The last line is the most important. `AssertFullSemver` will run GitVersion and

## 6. Submit a pull request with the failing test
Even better include the fix, but a failing test is a great start


# Build / Release Process
We use Cake for our build and deployment process. The way the build / release process is setup is:

1) We build releasable artifacts on AppVeyor
1) Login to AppVeyor
1) Deploy the latest master build
![docs/img/release-1-deploy.png](docs/img/release-1-deploy.png)
1) Choose GitVersion release, when you press deploy it will create a *non-released* GitHub release, this *will not* create a Git tag. This step is so we can validate the release and release notes before pushing the button.
![docs/img/release-2-deploy.png](docs/img/release-2-deploy.png)
1) All the artifacts should upload nicely
![docs/img/release-3-deploy.png](docs/img/release-3-deploy.png)
1) Head over to GitHub releases, you should have a draft release, download a copy of the release notes
![docs/img/release-4-deploy.png](docs/img/release-4-deploy.png)
1) Edit the release and do the following:
1. Remove the build metadata from the tag and title (the + and everything after it)
2. Paste the downloaded release notes in, you can clean them up if you want otherwise there may be closed issues which were questions etc.
3. Tick the pre-release box if it's pre-release
4. Press Publish
1) Publishing tags (a git tag) the release commit, this will trigger another appveyor build which only builds tags, this build uses deploy.cake. It downloads the artifacts from that GitHub release, then performs the release
Copy link
Member

Choose a reason for hiding this comment

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

I don't really understand this point. Isn't the tag automatically created through publishing the GitHub release (point before)? Are there additional tags which needs to be created?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Will clarify in the docs.

We push a non published github release, so it doesn't create a tag. The tag is created when you publish the release from the GitHub site

Copy link
Member

Choose a reason for hiding this comment

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

That's my confusion. In 4. Press Publish of the above point the tag will be created. Why does it need another step to create tags? Or is this just the explanation that the publish above does create tags (in this case IMHO it should be part of point 4. above), or should point 4 above be saving as draft instead of publish?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Sorry, AppVeyor creates a draft, I wanted to call out that publish at this point creates the tag and that runs the build


## Docker
It is a manual release step after the release now, first download the appropriate ZIP and put into a `releaseArtifacts` folder in the GitVersion repository, then run:

`docker build . --build-arg GitVersionZip=GitVersion_<VERSION>.zip --tag gittools/gitversion`
Binary file added docs/img/release-1-deploy.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/img/release-2-deploy.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/img/release-3-deploy.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/img/release-4-deploy.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.