Skip to content

Commit cca1697

Browse files
authored
Add a document for how releases are built.
1 parent 4d3bf13 commit cca1697

File tree

1 file changed

+41
-0
lines changed

1 file changed

+41
-0
lines changed

doc/How-Releases-Are-Made.md

+41
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
# How O# Releases Are Made
2+
3+
The OmniSharp [release pipeline](https://dev.azure.com/omnisharp/Builds/_build?definitionId=2) runs from the OmniSharp Azure DevOps instance. It is defined in [azure-pipelines.yml](/azure-pipelines.yml).
4+
5+
## Rolling Beta Builds
6+
7+
Merges into the master branch generate an empty draft GitHub release with a beta version tag. The tag created for the release then causes a build that uploads the packages.
8+
9+
```mermaid
10+
sequenceDiagram
11+
autonumber
12+
Maintainer ->> GitHub: Merges PR into the `master` branch
13+
GitHub --) OmniSharp ADO: Merge to `master` triggers pipeline
14+
activate OmniSharp ADO
15+
OmniSharp ADO ->> GitHub: Pulls source for omnisharp-roslyn
16+
note over OmniSharp ADO: Calculates a build version
17+
OmniSharp ADO ->> GitHub: Creates a draft release and `v#35;.#35;.#35;-beta.#35;` tag
18+
deactivate OmniSharp ADO
19+
GitHub --) OmniSharp ADO: `v*` tag creation triggers pipeline
20+
activate OmniSharp ADO
21+
OmniSharp ADO ->> GitHub: Pulls source for omnisharp-roslyn
22+
note over OmniSharp ADO: Builds packages for various platforms
23+
OmniSharp ADO ->> GitHub: Adds packages to release and unmark as draft
24+
deactivate OmniSharp ADO
25+
```
26+
27+
## Official Builds
28+
29+
A maintainer creates an empty draft GitHub release with the appropriate version tag. The tag created for the release then causes a build that uploads the packages.
30+
31+
```mermaid
32+
sequenceDiagram
33+
autonumber
34+
Maintainer ->> GitHub: Creates draft release with a`v#35;.#35;.#35;` tag
35+
GitHub --) OmniSharp ADO: `v*` tag creation triggers pipeline
36+
activate OmniSharp ADO
37+
OmniSharp ADO ->> GitHub: Pulls source for omnisharp-roslyn
38+
note over OmniSharp ADO: Builds packages for various platforms
39+
OmniSharp ADO ->> GitHub: Adds packages to release and unmark as draft
40+
deactivate OmniSharp ADO
41+
```

0 commit comments

Comments
 (0)