Skip to content

Commit 55ce269

Browse files
Add document for releasing the library (#68)
1 parent a0eb4b0 commit 55ce269

File tree

1 file changed

+37
-0
lines changed

1 file changed

+37
-0
lines changed

docs/Release.md

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
# Release a new version of the library
2+
3+
## Create the release
4+
* Get on the correct commit that we want to release (normally tip of main branch)
5+
* `git tag <tag-name>` (previous release format: v0.1.0-alpha3)
6+
* `git push origin <tag-name>`
7+
8+
## Fork
9+
* Fork the repo at https://github.com/microsoft/vcpkg
10+
- If you already have a fork, make sure it is updated to the master branch
11+
12+
![image](https://user-images.githubusercontent.com/7574801/128568379-deb14ed7-1ba3-4cb7-83d2-faecf8300f21.png)
13+
14+
* Clone your fork locally `git clone https://github.com/<fork>/vcpkg.git`
15+
16+
## Modify vcpkg/ports/microsoft-signalr/CONTROL
17+
* Update the `Version`
18+
* Add any new features we want users to be able to add/remove (msgpack, cpprestsdk, etc.)
19+
20+
## Modify vcpkg/ports/microsoft-signalr/portfile.cmake
21+
* Change the `REF` to be the tag name
22+
* Change the `SHA512`, this will be done in the step below
23+
* Update any flags we might want to set a default for in `vcpkg_configure_cmake`
24+
25+
## Test the changes
26+
* Run `./bootstrap-vcpkg.bat` to get the package installer
27+
* Run `vcpkg install microsoft-signalr:x64-windows` to install the library
28+
- The first time this runs it will fail with the wrong SHA512 and give us the correct value for the SHA512, so replace that value
29+
* To try out different features (defined in the CONTROL file) you can install with `vcpkg install microsoft-signalr[<feature name>]`, e.g. `<feature name>` -> `messagepack`
30+
* Do a smoke test that the library works, a sample app like https://github.com/halter73/SignalR-Client-Cpp-Sample explains how to do that quickly
31+
32+
## Make a pull request
33+
* Commit the modified files (should be 2 files minimum)
34+
* After making a first commit run `./vcpkg x-add-version microsoft-signalr --overwrite-version`
35+
- This will update 2 more files that vcpkg needs updated
36+
- Commit the new changes
37+
* Submit a PR from your fork to the https://github.com/microsoft/vcpkg repo

0 commit comments

Comments
 (0)