Skip to content

Commit b0e754b

Browse files
authored
Merge pull request #2116 from microsoft/ci/release-please-to-v1
ci/release please to v1
2 parents 46e8ad6 + cff2f2d commit b0e754b

File tree

10 files changed

+107
-15
lines changed

10 files changed

+107
-15
lines changed

.azure-pipelines/ci-build.yml

Lines changed: 7 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,9 @@ trigger:
88
- main
99
- dev
1010
- support/v1
11+
tags:
12+
include:
13+
- 'v*'
1114
pr:
1215
branches:
1316
include:
@@ -194,7 +197,7 @@ extends:
194197
content: '*.nupkg'
195198

196199
- stage: deploy
197-
condition: and(or(contains(variables['build.sourceBranch'], 'refs/heads/main'),contains(variables['build.sourceBranch'], 'refs/heads/support/v1')), succeeded())
200+
condition: and(contains(variables['build.sourceBranch'], 'refs/tags/v'), succeeded())
198201
dependsOn: build
199202
jobs:
200203
- deployment: deploy_hidi
@@ -305,18 +308,10 @@ extends:
305308
condition: succeededOrFailed()
306309
inputs:
307310
gitHubConnection: 'Github-MaggieKimani1'
308-
action: create
311+
action: edit
309312
tagSource: userSpecifiedTag
310-
tag: '$(artifactVersion)'
311-
title: '$(artifactVersion)'
313+
tag: 'v$(artifactVersion)'
312314
releaseNotesSource: inline
313315
assets: '$(Pipeline.Workspace)\**\*.exe'
314-
changeLogType: issueBased
315-
changeLogLabels: '[
316-
{ "label" : "feature-work", "feature", "displayName" : "New Features", "state" : "closed" },
317-
{ "label" : "enhancement", "V2-Enhancement", "displayName" : "Enhancements", "state" : "closed" },
318-
{ "label" : "bug", "bug-fix", "displayName" : "Bugs", "state" : "closed" },
319-
{ "label" : "documentation", "doc", "displayName" : "Documentation", "state" : "closed"},
320-
{ "label" : "dependencies", "displayName" : "Package Updates", "state" : "closed" }
321-
]'
316+
addChangeLog: false
322317

.github/release-please.yml

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
manifest: true
2+
primaryBranch: main
3+
handleGHRelease: true
4+
branches:
5+
- branch: support/v1
6+
manifest: true
7+
handleGHRelease: true

.release-please-manifest.json

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
{
2+
".": "1.6.23"
3+
}

CHANGELOG.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
# Changelog
2+
3+
All notable changes to this project will be documented in this file.
4+
5+
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
6+
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
7+

CONTRIBUTING.md

Lines changed: 52 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,52 @@
1+
# Contributing to OpenAPI.net
2+
3+
OpenAPI.net is a mono-repo containing source code for the following packages:
4+
5+
## Libraries
6+
7+
| Library | NuGet Release |
8+
|----------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
9+
| [Microsoft.OpenAPI](./src/Microsoft.OpenAPI/README.md) | [![NuGet Version](https://img.shields.io/nuget/vpre/Microsoft.OpenAPI?label=Latest&logo=nuget)](https://www.nuget.org/packages/Microsoft.OpenAPI/) |
10+
| [Microsoft.OpenAPI.Readers](./src/Microsoft.OpenAPI.Readers/README.md) | [![NuGet Version](https://img.shields.io/nuget/vpre/Microsoft.OpenAPI.Readers?label=Latest&logo=nuget)](https://www.nuget.org/packages/Microsoft.OpenAPI.Readers/) |
11+
| [Microsoft.OpenAPI.Hidi](./src/Microsoft.OpenAPI.Hidi/README.md) | [![NuGet Version](https://img.shields.io/nuget/vpre/Microsoft.OpenAPI.Hidi?label=Latest&logo=nuget)](https://www.nuget.org/packages/Microsoft.OpenAPI.Hidi/) |
12+
13+
OpenAPI.net is open to contributions. There are a couple of different recommended paths to get contributions into the released version of this library.
14+
15+
__NOTE__ A signed a contribution license agreement is required for all contributions, and is checked automatically on new pull requests. Please read and sign [the agreement](https://cla.microsoft.com/) before starting any work for this repository.
16+
17+
## File issues
18+
19+
The best way to get started with a contribution is to start a dialog with the owners of this repository. Sometimes features will be under development or out of scope for this SDK and it's best to check before starting work on contribution. Discussions on bugs and potential fixes could point you to the write change to make.
20+
21+
## Submit pull requests for bug fixes and features
22+
23+
Feel free to submit a pull request with a linked issue against the __main__ branch. The main branch will be updated frequently.
24+
## Commit message format
25+
26+
To support our automated release process, pull requests are required to follow the [Conventional Commit](https://www.conventionalcommits.org/en/v1.0.0/)
27+
format.
28+
Each commit message consists of a __header__, an optional __body__ and an optional __footer__. The header is the first line of the commit and
29+
MUST have a __type__ (see below for a list of types) and a __description__. An optional __scope__ can be added to the header to give extra context.
30+
31+
```
32+
<type>[optional scope]: <short description>
33+
<BLANK LINE>
34+
<optional body>
35+
<BLANK LINE>
36+
<optional footer(s)>
37+
```
38+
39+
The recommended commit types used are:
40+
41+
- __feat__ for feature updates (increments the _minor_ version)
42+
- __fix__ for bug fixes (increments the _patch_ version)
43+
- __perf__ for performance related changes e.g. optimizing an algorithm
44+
- __refactor__ for code refactoring changes
45+
- __test__ for test suite updates e.g. adding a test or fixing a test
46+
- __style__ for changes that don't affect the meaning of code. e.g. formatting changes
47+
- __docs__ for documentation updates e.g. ReadMe update or code documentation updates
48+
- __build__ for build system changes (gradle updates, external dependency updates)
49+
- __ci__ for CI configuration file changes e.g. updating a pipeline
50+
- __chore__ for miscallaneous non-sdk changesin the repo e.g. removing an unused file
51+
52+
Adding an exclamation mark after the commit type (`feat!`) or footer with the prefix __BREAKING CHANGE:__ will cause an increment of the _major_ version.

Directory.Build.props

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,7 @@
1212
<PackageProjectUrl>https://github.com/Microsoft/OpenAPI.NET</PackageProjectUrl>
1313
<Copyright>© Microsoft Corporation. All rights reserved.</Copyright>
1414
<PackageTags>OpenAPI .NET</PackageTags>
15+
<Version>1.6.23</Version>
1516
</PropertyGroup>
1617
<!-- https://github.com/clairernovotny/DeterministicBuilds#deterministic-builds -->
1718
<PropertyGroup Condition="'$(TF_BUILD)' == 'true'">

release-please-config.json

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
{
2+
"bootstrap-sha": "dfa9c8a12ea2279905ee3e67e21212fa3b8bb95c",
3+
"exclude-paths": [
4+
".azure-pipelines",
5+
".github",
6+
".idea",
7+
".vs",
8+
".vscode"
9+
],
10+
"release-type": "simple",
11+
"bump-minor-pre-major": true,
12+
"bump-patch-for-minor-pre-major": true,
13+
"include-component-in-tag": false,
14+
"include-v-in-tag": true,
15+
"draft": false,
16+
"packages": {
17+
".": {
18+
"package-name": "Microsoft.OpenApi",
19+
"changelog-path": "CHANGELOG.md",
20+
"extra-files": [
21+
{
22+
"type": "xml",
23+
"path": "Directory.Build.props",
24+
"xpath": "//Project/PropertyGroup/Version"
25+
}
26+
]
27+
}
28+
},
29+
"$schema": "https://raw.githubusercontent.com/googleapis/release-please/main/schemas/config.json"
30+
}

src/Microsoft.OpenApi.Hidi/Microsoft.OpenApi.Hidi.csproj

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,6 @@
99
<Nullable>enable</Nullable>
1010
<ToolCommandName>hidi</ToolCommandName>
1111
<PackageOutputPath>./../../artifacts</PackageOutputPath>
12-
<Version>1.4.22</Version>
1312
<Description>OpenAPI.NET CLI tool for slicing OpenAPI documents</Description>
1413
<SignAssembly>true</SignAssembly>
1514
<!-- https://github.com/dotnet/sourcelink/blob/main/docs/README.md#embeduntrackedsources -->

src/Microsoft.OpenApi.Readers/Microsoft.OpenApi.Readers.csproj

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,6 @@
33
<TargetFramework>netstandard2.0</TargetFramework>
44
<LangVersion>latest</LangVersion>
55
<GeneratePackageOnBuild>true</GeneratePackageOnBuild>
6-
<Version>1.6.23</Version>
76
<Description>OpenAPI.NET Readers for JSON and YAML documents</Description>
87
<SignAssembly>true</SignAssembly>
98
<!-- https://github.com/dotnet/sourcelink/blob/main/docs/README.md#embeduntrackedsources -->

src/Microsoft.OpenApi/Microsoft.OpenApi.csproj

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,6 @@
33
<TargetFramework>netstandard2.0</TargetFramework>
44
<LangVersion>Latest</LangVersion>
55
<GeneratePackageOnBuild>true</GeneratePackageOnBuild>
6-
<Version>1.6.23</Version>
76
<Description>.NET models with JSON and YAML writers for OpenAPI specification</Description>
87
<SignAssembly>true</SignAssembly>
98
<!-- https://github.com/dotnet/sourcelink/blob/main/docs/README.md#embeduntrackedsources -->

0 commit comments

Comments
 (0)