mirror of https://github.com/winsw/winsw
40 lines
2.3 KiB
Markdown
40 lines
2.3 KiB
Markdown
# WinSW Developer Information
|
|
|
|
### Build Environment
|
|
|
|
* *winsw_key.snk* should be available in the project's root in order to build the executable
|
|
* You can generate the certificate by running *generate-key.ps1*
|
|
* The certificate is in *.gitignore* list. Please do not add it to the repository
|
|
|
|
### Continuous Integration
|
|
|
|
Project has a continuous integration flow being hosted by AppVeyor ([project page](https://ci.appveyor.com/project/winsw/winsw)).
|
|
This CI instance automates building and testing of the Release configuration of WinSW.
|
|
See [the appveyor.yml file](./appveyor.yml) for more details.
|
|
|
|
Versions generated by the CI instances are **NOT** aligned with the release version, they use a rolling version ID instead.
|
|
|
|
### Releasing to GitHub and NuGet
|
|
|
|
Releases are being performed to 3 locations: GitHub, NuGet, and Jenkins Maven Repository.
|
|
For all these releases we use binaries being created by the special AppVeyor Job ([winsw-release](https://ci.appveyor.com/project/oleg-nenashev/winsw-release)).
|
|
|
|
Here are the release steps:
|
|
|
|
1. Integrate all pull requests you want to release to the master branch.
|
|
1. Update [CHANGELOG](./CHANGELOG.md) and push changes to the master.
|
|
1. Wait till the [AppVeyor build](https://ci.appveyor.com/project/winsw/winsw) finishes for the last commit.
|
|
1. Go to the [winsw-release job page](https://ci.appveyor.com/project/oleg-nenashev/winsw-g2fwp).
|
|
1. If you are doing a release with a new feature, bump the second digit in the _Version_ setting (e.g. to `2.N.${build}`) and change the next build number to `0`. In such case the version in assembly info will be `2.N.0`
|
|
1. Run the [winsw-release](https://ci.appveyor.com/project/oleg-nenashev/winsw-g2fwp) build.
|
|
Once it completes, ensure the version is correct.
|
|
1. Click on the _Deploy_ button for the build.
|
|
Then deploy changes to _GitHub Releases_ and NuGet using the available publishers.
|
|
1. Go to [GitHub Releases](https://github.com/winsw/winsw/releases), find the published Release, click on *Edit release* and then uncheck the *This is a pre-release* checkbox to make the release public.
|
|
|
|
### Releasing to the Maven repository (legacy)
|
|
|
|
Maven repository is no longer the main source of releases,
|
|
but some projects still depend on WinSW from the Jenkins Maven repository.
|
|
Maven Packaging repository can be found [here](https://github.com/jenkinsci/winsw-maven-packaging).
|