Skip to content

Commit 7aa15bb

Browse files
author
Kapil Borle
authored
Add instuctions to make a release (#843)
1 parent 2056fe0 commit 7aa15bb

File tree

1 file changed

+23
-1
lines changed

1 file changed

+23
-1
lines changed

README.md

+23-1
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,7 @@ Table of Contents
2929
- [Violation Correction](#violation-correction)
3030
- [Project Management Dashboard](#project-management-dashboard)
3131
- [Contributing to ScriptAnalyzer](#contributing-to-scriptanalyzer)
32+
- [Creating a Release](#creating-a-release)
3233
- [Code of Conduct](#code-of-conduct)
3334

3435
<!-- tocstop -->
@@ -402,8 +403,29 @@ Before submitting a feature or substantial code contribution, please discuss it
402403

403404
[Back to ToC](#table-of-contents)
404405

406+
Creating a Release
407+
================
408+
409+
- Update changelog (`changelog.md`) with the new version number and change set. When updating the changelog please follow the same pattern as that of previous change sets (otherwise this may break the next step).
410+
- Import the ReleaseMaker module and execute `New-Release` cmdlet to perform the following actions.
411+
- Update module manifest (engine/PSScriptAnalyzer.psd1) with the new version number and change set
412+
- Update the version number in `engine/project.json` and `rules/project.json`
413+
- Create a release build in `out/`
414+
415+
```powershell
416+
PS> Import-Module .\Utils\ReleaseMaker.psm1
417+
PS> New-Release
418+
```
419+
420+
- Sign the binaries and PowerShell files in the release build and publish the module to [PowerShell Gallery](www.powershellgallery.com).
421+
- Create a PR on `development` branch, with all the changes made in the previous step.
422+
- Merge the changes to `development` and then merge `development` to `master` (Note that the `development` to `master` merge should be a `fast-forward` merge).
423+
- Draft a new release on github and tag `master` with the new version number.
424+
425+
[Back to ToC](#table-of-contents)
426+
405427
Code of Conduct
406428
===============
407429
This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/). For more information see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) or contact [[email protected]](mailto:[email protected]) with any additional questions or comments.
408430

409-
[Back to ToC](#table-of-contents)
431+
[Back to ToC](#table-of-contents)

0 commit comments

Comments
 (0)