Commit df664ab

authored

Merge pull request #392 from json-api-dotnet/chore/back-port-docs

update build config, bump package version and document process

2 parents 46fcc98 + a3b3af4 commit df664abCopy full SHA for df664ab

File tree

2 files changed

+39

-0

lines changed

.github
- CONTRIBUTING.MD
appveyor.yml

2 files changed

+39

-0

lines changed

`‎.github/CONTRIBUTING.MD‎`

Lines changed: 26 additions & 0 deletions

Original file line number	Diff line number	Diff line change
`@@ -13,3 +13,29 @@ I have chosen to loosely follow the [Angular Commit Guidelines](https://github.c`
`13`	`13`	`# Documentation`
`14`	`14`
`15`	`15`	`If you'd like to help us improve our documentation, please checkout our [GitHub pages repository](https://github.com/json-api-dotnet/json-api-dotnet.github.io) where we host our documentation.`
	`16`	`+`
	`17`	`+# Backporting Features To Prior Releases`
	`18`	`+`
	`19`	+To backport a feature that has been approved and merged into `master`:
	`20`	`+`
	`21`	`+## Requester`
	`22`	`+`
	`23`	`+Open an issue requesting the feature you would like backported. The change will be reviewed based on:`
	`24`	`+`
	`25`	`+- compatibility`
	`26`	`+- difficulty in porting the change`
	`27`	`+- the added value the feature provides for users on the older versions`
	`28`	`+- how difficult it is for users to migrate from the older version to the newer version`
	`29`	`+`
	`30`	`+## Maintainer`
	`31`	`+`
	`32`	`+- Checkout the version you want to apply the feature on top of and create a new branch to release the new version:`
	`33`	+ ```
	`34`	`+ git checkout tags/v2.5.1 -b release/2.5.2`
	`35`	+ ```
	`36`	+- Cherrypick the merge commit: `git cherry-pick {git commit SHA}`
	`37`	`+- Bump the package version in the csproj`
	`38`	`+- Make any other compatibility, documentation or tooling related changes`
	`39`	`+- Push the branch to origin and verify the build`
	`40`	`+- Once the build is verified, create a GitHub release, tagging the release branch`
	`41`	`+- Open a PR back to master with any other additions`

`‎appveyor.yml‎`

Lines changed: 13 additions & 0 deletions

Original file line number	Diff line number	Diff line change
`@@ -18,6 +18,7 @@ branches:`
`18`	`18`	`- master`
`19`	`19`	`- develop`
`20`	`20`	`- unstable`
	`21`	`+ - /release\/.+/`
`21`	`22`
`22`	`23`	`nuget:`
`23`	`24`	`disable_publish_on_pr: true`
`@@ -38,6 +39,7 @@ test: off`
`38`	`39`	`artifacts:`
`39`	`40`	`- path: .\\artifacts\\*.nupkg`
`40`	`41`	`name: NuGet`
	`42`	`+`
`41`	`43`	`deploy:`
`42`	`44`	`- provider: NuGet`
`43`	`45`	`server: https://www.myget.org/F/research-institute/api/v2/package`
`@@ -47,17 +49,28 @@ deploy:`
`47`	`49`	`symbol_server: https://www.myget.org/F/research-institute/symbols/api/v2/package`
`48`	`50`	`on:`
`49`	`51`	`branch: develop`
	`52`	`+`
`50`	`53`	`- provider: NuGet`
`51`	`54`	`server: https://www.myget.org/F/jadnc/api/v2/package`
`52`	`55`	`api_key:`
`53`	`56`	`secure: 6CeYcZ4Ze+57gxfeuHzqP6ldbUkPtF6pfpVM1Gw/K2jExFrAz763gNAQ++tiacq3`
`54`	`57`	`skip_symbols: false`
`55`	`58`	`on:`
`56`	`59`	`branch: unstable`
	`60`	`+`
`57`	`61`	`- provider: NuGet`
`58`	`62`	`name: production`
	`63`	`+ skip_symbols: false`
`59`	`64`	`api_key:`
`60`	`65`	`secure: /fsEOgG4EdtNd6DPmko9h3NxQwx1IGDcFreGTKd2KA56U2KEkpX/L/pCGpCIEf2s`
`61`	`66`	`on:`
`62`	`67`	`branch: master`
`63`	`68`	`appveyor_repo_tag: true`
	`69`	`+`
	`70`	`+- provider: NuGet`
	`71`	`+ skip_symbols: false`
	`72`	`+ api_key:`
	`73`	`+ secure: /fsEOgG4EdtNd6DPmko9h3NxQwx1IGDcFreGTKd2KA56U2KEkpX/L/pCGpCIEf2s`
	`74`	`+ on:`
	`75`	`+ branch: /release\/.+/`
	`76`	`+ appveyor_repo_tag: true`

0 commit comments

Comments

(0)

Navigation Menu

Search code, repositories, users, issues, pull requests...

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Uh oh!

Commit df664ab

File tree

2 files changed

2 files changed

`‎.github/CONTRIBUTING.MD‎`

`‎appveyor.yml‎`

0 commit comments