-
Notifications
You must be signed in to change notification settings - Fork 418
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add a document for how releases are built.
- Loading branch information
Showing
1 changed file
with
41 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,41 @@ | ||
# How O# Releases Are Made | ||
|
||
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). | ||
|
||
## Rolling Beta Builds | ||
|
||
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. | ||
|
||
```mermaid | ||
sequenceDiagram | ||
autonumber | ||
Maintainer ->> GitHub: Merges PR into the `master` branch | ||
GitHub --) OmniSharp ADO: Merge to `master` triggers pipeline | ||
activate OmniSharp ADO | ||
OmniSharp ADO ->> GitHub: Pulls source for omnisharp-roslyn | ||
note over OmniSharp ADO: Calculates a build version | ||
OmniSharp ADO ->> GitHub: Creates a draft release and `v#35;.#35;.#35;-beta.#35;` tag | ||
deactivate OmniSharp ADO | ||
GitHub --) OmniSharp ADO: `v*` tag creation triggers pipeline | ||
activate OmniSharp ADO | ||
OmniSharp ADO ->> GitHub: Pulls source for omnisharp-roslyn | ||
note over OmniSharp ADO: Builds packages for various platforms | ||
OmniSharp ADO ->> GitHub: Adds packages to release and unmark as draft | ||
deactivate OmniSharp ADO | ||
``` | ||
|
||
## Official Builds | ||
|
||
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. | ||
|
||
```mermaid | ||
sequenceDiagram | ||
autonumber | ||
Maintainer ->> GitHub: Creates draft release with a`v#35;.#35;.#35;` tag | ||
GitHub --) OmniSharp ADO: `v*` tag creation triggers pipeline | ||
activate OmniSharp ADO | ||
OmniSharp ADO ->> GitHub: Pulls source for omnisharp-roslyn | ||
note over OmniSharp ADO: Builds packages for various platforms | ||
OmniSharp ADO ->> GitHub: Adds packages to release and unmark as draft | ||
deactivate OmniSharp ADO | ||
``` |