Skip to content
This repository was archived by the owner on Dec 7, 2021. It is now read-only.

Commit 80add1a

Browse files
authored
Merge pull request #964 from microsoft/myho/updateReleasePipeline
chore: update & document release process
2 parents 94daa11 + dba6dfe commit 80add1a

24 files changed

+1780
-1735
lines changed

RELEASE_GUIDE.md

Lines changed: 66 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,66 @@
1+
# Overview
2+
3+
[![Build Status](https://dev.azure.com/msft-vott/VoTT/_apis/build/status/VoTT/Create%20Release?branchName=master)](https://dev.azure.com/msft-vott/VoTT/_build/latest?definitionId=55&branchName=master)
4+
5+
Instruction on how to create new GitHub & Web Releases.
6+
7+
## Release Process
8+
9+
![alt text](./docs/images/release-process.png "Create Release Process")
10+
11+
### AzDO Tasks
12+
13+
[GitHub Release Task](https://github.com/microsoft/azure-pipelines-tasks/tree/master/Tasks/GitHubReleaseV1)
14+
15+
[Azure File Copy](https://github.com/microsoft/azure-pipelines-tasks/tree/master/Tasks/AzureFileCopyV3)
16+
17+
## Versioning
18+
19+
Follow [NPM Semantic Versioning](https://docs.npmjs.com/about-semantic-versioning#incrementing-semantic-versions-in-published-packages)
20+
21+
| Code status | Stage | Rule | Example version |
22+
| ----------------------------------------- | ------------- | ------------------------------------------------------------------ | --------------- |
23+
| First release | New product | Start with 1.0.0 | 1.0.0 |
24+
| Backward compatible bug fixes | Patch release | Increment the third digit | 1.0.1 |
25+
| Backward compatible new features | Minor release | Increment the middle digit and reset last digit to zero | 1.1.0 |
26+
| Changes that break backward compatibility | Major release | Increment the first digit and reset middle and last digits to zero | 2.0.0 |
27+
28+
### Commands
29+
30+
The pipeline use [npm-version](https://docs.npmjs.com/cli/version) to update version
31+
32+
#### Pre
33+
34+
All version with `pre`, ie. `preminor` will bump the appropriate didgit & append `-0` to the new version
35+
36+
Examples:
37+
38+
`npm version prepatch`
39+
40+
1. v2.3.0 --> v2.3.1-0
41+
1. v2.3.1-0 --> v2.3.2-0
42+
43+
`npm version preminor`
44+
45+
1. v2.3.0 --> v2.4.0-0
46+
1. v2.4.0-0 --> v2.5.0-0
47+
48+
##### Exception
49+
50+
`prerelease` behave similar to prepatch, but would increment the last digit.
51+
52+
Examples:
53+
54+
`npm version prerelease`
55+
56+
v2.3.0 --> v2.3.1-0
57+
58+
v2.3.0-0 --> v2.3.0-1
59+
60+
#### Major
61+
62+
v2.x.x --> v3.0.0
63+
64+
#### Minor
65+
66+
v2.2.0 --> v2.3.0

azure-pipelines/create-release.yml

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
name: "GitHub & Web Release [$(SourceBranchName)] - $(Date:yyyyMMdd)$(Rev:.r)"
2+
3+
trigger: none # manual queue only when we're ready to release
4+
pr: none # disable CI build for PR
5+
6+
variables:
7+
azureSubscription: "pj-little-sub"
8+
DEV_STORAGE_ACCOUNT: 'vottdev'
9+
PROD_STORAGE_ACCOUNT: 'vott'
10+
DEV_URL: "https://vottdev.z5.web.core.windows.net/"
11+
PROD_URL: "https://vott.z22.web.core.windows.net/"
12+
13+
stages:
14+
- stage: version_bump_commit
15+
jobs:
16+
- template: templates/npm-version-bump.yml
17+
parameters:
18+
versionType: $(NPM_VERSION_TYPE)
19+
20+
- stage: github_release
21+
dependsOn: version_bump_commit
22+
jobs:
23+
- template: templates/create-github-release.yml
24+
parameters:
25+
GitHubConnection: 'GitHub connection' # defaults for any parameters that aren't specified
26+
repositoryName: '$(Build.Repository.Name)' # microsoft/VoTT
27+
isPreRelease: $(IS_PRERELEASE) # set when queuing build
28+
isDraft: $(IS_DRAFT)
29+
30+
- stage: web_release
31+
dependsOn: version_bump_commit
32+
jobs:
33+
- template: templates/create-web-release.yml

azure-pipelines/linux/artifact-build-linux.yml

Lines changed: 0 additions & 26 deletions
This file was deleted.

azure-pipelines/mac/artifact-build-mac.yml

Lines changed: 0 additions & 22 deletions
This file was deleted.

azure-pipelines/plato/generate-up-to-date-report.yml

Lines changed: 0 additions & 69 deletions
This file was deleted.

azure-pipelines/releases/README.md

Lines changed: 0 additions & 5 deletions
This file was deleted.

0 commit comments

Comments
 (0)