Automate Release Process (#45)

gasparnagy · web-flow · commit f1dd0c4c3229 · 2024-11-20T16:10:34.000+01:00
* update CI process * fix reading version * Add release job (unfinished) * remove bom from vstemplate * update vstemplates during version bump * remove release step conditions for test * change job to use windows * Revert "change job to use windows" This reverts commit a2522a3. * add "tfx extension publish --help" * comment out tests for faster debug * npm install -g tfx-cli * Revert "npm install -g tfx-cli" This reverts commit 6b27bce. * Revert "add "tfx extension publish --help"" This reverts commit 28e6f64. * Reapply "change job to use windows" This reverts commit bc740c6. * use GHA-VSMarketplacePublisher to publish * cleanup Deploy VSIX packages * disable Deploy VSIX packages * remove unneeded target to set the version in vstemplate * Add Review modified files * Add Verify VSIX Deploy settings * updated CHANGELOG * undo temp changes * add RELEASING.md
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
diff --git a/.marketplace/publishManifest.json b/.marketplace/publishManifest.json
@@ -6,7 +6,7 @@
     },
     "overview": "overview.md",
     "priceCategory": "free",
-    "publisher": "reqnroll",
+    "publisher": "Reqnroll",
     "private": false,
     "qna": true,
     "repo": "https://github.com/reqnroll/Reqnroll.VisualStudio"
diff --git a/.vscode/settings.json b/.vscode/settings.json
@@ -1,5 +1,6 @@
 {
   "cSpell.words": [
     "Reqnroll"
-  ]
+  ],
+  "markdown.extension.toc.updateOnSave": false
 }
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -4,7 +4,7 @@
 
 *Added support for .NET 9 through the Visual Studio extension.
 
-*Contributors of this release (in alphabetical order):* @UL-ChrisGlew
+*Contributors of this release (in alphabetical order):* @gasparnagy, @UL-ChrisGlew
 
 # v2024.6.176 - 2024-11-08
 
diff --git a/RELEASING.md b/RELEASING.md
@@ -0,0 +1,50 @@
+# Releasing
+
+This document describes how to make a release using GitHub Actions.  
+
+There are two parts to making a release:
+
+* [Prepare the release](#prepare-the-release)
+* [Make the release](#make-the-release)
+
+If you're making a major or minor release it is recommended to discuss it with the other contributors upfront (e.g. on Discord).
+
+## Prepare the release
+
+Anyone with permission to push to the `main` branch can prepare a release.
+
+1. Add new information to `CHANGELOG.md`. Ideally the `CHANGELOG.md` should be up-to-date, but sometimes there will be accidental omissions when merging PRs.
+    * Use `git log --format=format:"* %s (%an)" --reverse <last-version-tag>..HEAD` to list all commits since the last release.
+    * Add changelog details under the `# [vNext]` heading; the release process will update this heading when it makes the release
+1. Check & update contributors list (if applicable)
+    * List recent contributors:
+      ```
+      git log --format=format:"%an <%ae>" --reverse <last-version-tag>..HEAD  | grep -vEi "(renovate|dependabot|Snyk)" | sort| uniq -i
+      ```
+    * Update contributors if necessary at the `Contributors of this release` part of the `# [vNext]` heading
+1. The Visual Studio extension releases are versioned sequentially within a year, with the format `YYYY.SEQ.BUILD` (e.g. `2024.5.182`). In the beginning of the year, the year number must be updated and the sequence number has to be reset to `1`. When preparing the release you just need to double-check if the version is correct. You can find the current version number in the `Directory.Build.props` file.
+
+## Make the release
+
+Only people in group [release-managers](https://github.com/orgs/reqnroll/teams/release-managers) can make releases and only from the `main` branch.
+
+### Making a preview release
+
+Making preview releases are currently not supported, but each build contains a deploy target with the `vsix` installation file included. Installing those could be used to test preview versions.
+
+### Making a production release
+
+Production releases (or just releases) are intended to use for any users. Their version number does not contain a version suffix.
+
+To release such a preview release, the following steps has to be done:
+
+1. Open the CI workflow at GitHub: https://github.com/reqnroll/Reqnroll.VisualStudio/actions/workflows/ci.yml
+1. Choose the "Run workflow" button to trigger the release with the following settings:
+   * `deploy_packages`: checked
+   * `is_production_release`: checked
+   * `custom_version_suffix`: leave it empty
+   * `custom_configuration`: leave it on default
+1. The CI workflow runs and ideally passes all core and testing jobs, but will stop for approval before running the `release` job.
+1. Make sure everything is OK. You can even download the packages to be published for a smoke test if necessary. 
+1. If everything is fine, approve the deployment job.
+1. The job will publish the packages, tag the current commit and create a new commit with the updated version number and changelog header.
diff --git a/Reqnroll.VisualStudio.ItemTemplates/FeatureFile/FeatureFile_CSharp.vstemplate b/Reqnroll.VisualStudio.ItemTemplates/FeatureFile/FeatureFile_CSharp.vstemplate
@@ -1,4 +1,4 @@
-﻿<VSTemplate Version="2.0.0" xmlns="http://schemas.microsoft.com/developer/vstemplate/2005" Type="Item">
+<VSTemplate Version="2.0.0" xmlns="http://schemas.microsoft.com/developer/vstemplate/2005" Type="Item">
   <TemplateData>
     <DefaultName>Feature.feature</DefaultName>
     <Name>Feature File for Reqnroll</Name>
diff --git a/Reqnroll.VisualStudio.ItemTemplates/FeatureFile/FeatureFile_VB.vstemplate b/Reqnroll.VisualStudio.ItemTemplates/FeatureFile/FeatureFile_VB.vstemplate
@@ -1,4 +1,4 @@
-﻿<VSTemplate Version="2.0.0" xmlns="http://schemas.microsoft.com/developer/vstemplate/2005" Type="Item">
+<VSTemplate Version="2.0.0" xmlns="http://schemas.microsoft.com/developer/vstemplate/2005" Type="Item">
   <TemplateData>
     <DefaultName>Feature.feature</DefaultName>
     <Name>Feature File for Reqnroll</Name>
diff --git a/Reqnroll.VisualStudio.ItemTemplates/Hooks/Hooks_CSharp.vstemplate b/Reqnroll.VisualStudio.ItemTemplates/Hooks/Hooks_CSharp.vstemplate
@@ -1,4 +1,4 @@
-﻿<VSTemplate Version="2.0.0" xmlns="http://schemas.microsoft.com/developer/vstemplate/2005" Type="Item">
+<VSTemplate Version="2.0.0" xmlns="http://schemas.microsoft.com/developer/vstemplate/2005" Type="Item">
 	<TemplateData>
 		<DefaultName>Hooks.cs</DefaultName>
 		<Name>Reqnroll Hooks (event bindings)</Name>
diff --git a/Reqnroll.VisualStudio.ItemTemplates/Hooks/Hooks_VB.vstemplate b/Reqnroll.VisualStudio.ItemTemplates/Hooks/Hooks_VB.vstemplate
@@ -1,4 +1,4 @@
-﻿<VSTemplate Version="2.0.0" xmlns="http://schemas.microsoft.com/developer/vstemplate/2005" Type="Item">
+<VSTemplate Version="2.0.0" xmlns="http://schemas.microsoft.com/developer/vstemplate/2005" Type="Item">
 	<TemplateData>
 		<DefaultName>Hooks.cs</DefaultName>
 		<Name>Reqnroll Hooks (event bindings)</Name>
diff --git a/Reqnroll.VisualStudio.ItemTemplates/ReqnrollConfig/ReqnrollConfig_CSharp.vstemplate b/Reqnroll.VisualStudio.ItemTemplates/ReqnrollConfig/ReqnrollConfig_CSharp.vstemplate
@@ -1,4 +1,4 @@
-﻿<?xml version="1.0" encoding="utf-8"?>
+<?xml version="1.0" encoding="utf-8"?>
 <VSTemplate Version="3.0.0" Type="Item" xmlns="http://schemas.microsoft.com/developer/vstemplate/2005">
   <TemplateData>
     <DefaultName>reqnroll.json</DefaultName>
diff --git a/Reqnroll.VisualStudio.ItemTemplates/ReqnrollConfig/ReqnrollConfig_VB.vstemplate b/Reqnroll.VisualStudio.ItemTemplates/ReqnrollConfig/ReqnrollConfig_VB.vstemplate
@@ -1,4 +1,4 @@
-﻿<?xml version="1.0" encoding="utf-8"?>
+<?xml version="1.0" encoding="utf-8"?>
 <VSTemplate Version="3.0.0" Type="Item" xmlns="http://schemas.microsoft.com/developer/vstemplate/2005">
   <TemplateData>
     <DefaultName>reqnroll.json</DefaultName>
diff --git a/Reqnroll.VisualStudio.Package/Reqnroll.VisualStudio.Package.csproj b/Reqnroll.VisualStudio.Package/Reqnroll.VisualStudio.Package.csproj
@@ -99,19 +99,6 @@
 
   <Import Project="..\Connectors\DeploymentAssets.props" />
 
-  <Target Name="ReplaceVersions" AfterTargets="GetBuildVersion" BeforeTargets="BeforeCompile">
-    <ItemGroup>
-      <TemplateFiles Include="$(MSBuildThisFileDirectory)..\Reqnroll.VisualStudio.ItemTemplates\**\*.vstemplate" />
-      <TemplateFiles Include="$(MSBuildThisFileDirectory)..\Reqnroll.VisualStudio.ProjectTemplate\**\*.vstemplate" />
-      <VsChangeLog Include="$(MSBuildThisFileDirectory)..\CHANGELOG.md" />
-    </ItemGroup>
-
-    <WriteLinesToFile File="%(TemplateFiles.FullPath)" Lines="$([System.Text.RegularExpressions.Regex]::Replace($([System.IO.File]::ReadAllText(%(TemplateFiles.FullPath))), 'Version=(\d+).(\d+).(\d+).(\d+),', 'Version=$(AssemblyVersion),'))" Overwrite="true" Encoding="UTF-8" />
-
-    <WriteLinesToFile Condition=" '$(Configuration)' == 'Release' " File="%(VsChangeLog.FullPath)" Lines="$([System.IO.File]::ReadAllText(%(VsChangeLog.FullPath)).Replace('[vNext]','v$(Version) - $([System.DateTime]::Now.ToString('yyyy-MM-dd'))'))" Overwrite="true" Encoding="UTF-8" />
-
-  </Target>
-
   <!-- needed to include version in source.extension.vsixmanifest -->
   <Target Name="GetVsixVersion" Returns="$(ReqnrollPackageVersion)" BeforeTargets="BeforeCompile" AfterTargets="GetBuildVersion">
     <Message Text="VSIX Version is set to: $(ReqnrollPackageVersion)" />
diff --git a/Reqnroll.VisualStudio.ProjectTemplate/Reqnroll.VisualStudio.ProjectTemplate.vstemplate b/Reqnroll.VisualStudio.ProjectTemplate/Reqnroll.VisualStudio.ProjectTemplate.vstemplate
@@ -1,4 +1,4 @@
-﻿<?xml version="1.0" encoding="utf-8"?>
+<?xml version="1.0" encoding="utf-8"?>
 <VSTemplate Version="3.0.0" Type="Project" xmlns="http://schemas.microsoft.com/developer/vstemplate/2005" xmlns:sdk="http://schemas.microsoft.com/developer/vstemplate-sdkextension/2010">
   <TemplateData>
     <Name>Reqnroll Project</Name>
diff --git a/Reqnroll.VisualStudio.sln b/Reqnroll.VisualStudio.sln
@@ -57,6 +57,7 @@ Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "Repo", "Repo", "{31ACD27E-7
 		Directory.Build.targets = Directory.Build.targets
 		LICENSE = LICENSE
 		README.md = README.md
+		RELEASING.md = RELEASING.md
 	EndProjectSection
 EndProject
 Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "Reqnroll.VisualStudio.UI.Tester", "Tests\Reqnroll.VisualStudio.UI.Tester\Reqnroll.VisualStudio.UI.Tester.csproj", "{2A412F65-68C7-4A5D-AFCF-74E928C40C21}"
diff --git a/Tests/Reqnroll.VisualStudio.Specs/Features/Editor/SyntaxColoring.feature b/Tests/Reqnroll.VisualStudio.Specs/Features/Editor/SyntaxColoring.feature
@@ -369,7 +369,7 @@ Scenario: Highlights Scenario Outline placeholders
 Rule: Language configuration changes are applied to open feature file editors
 
 # this scenario is flaky on CI
-@quarantaine
+@quarantine
 Scenario: Default feature file language was changed
 	Given there is a non-Reqnroll project scope
 	And the reqnroll.json configuration file contains
diff --git a/Tests/Reqnroll.VisualStudio.Specs/Features/Editor/SyntaxErrors.feature b/Tests/Reqnroll.VisualStudio.Specs/Features/Editor/SyntaxErrors.feature
@@ -7,7 +7,7 @@ Rules:
 	* Highlights semantic errors
 
 # this scenario is flaky on CI
-@quarantaine
+@quarantine
 Scenario: Highlights syntax errors
 	Given there is a Reqnroll project scope
 	When the following feature file is opened in the editor

Original file line number	Diff line number	Diff line change
`@@ -1,5 +1,6 @@`
`1`	`1`	`{`
`2`	`2`	`"cSpell.words": [`
`3`	`3`	`"Reqnroll"`
`4`		`- ]`
	`4`	`+ ],`
	`5`	`+ "markdown.extension.toc.updateOnSave": false`
`5`	`6`	`}`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-<VSTemplate Version="2.0.0" xmlns="http://schemas.microsoft.com/developer/vstemplate/2005" Type="Item">`
	`1`	`+<VSTemplate Version="2.0.0" xmlns="http://schemas.microsoft.com/developer/vstemplate/2005" Type="Item">`
`2`	`2`	`<TemplateData>`
`3`	`3`	`<DefaultName>Feature.feature</DefaultName>`
`4`	`4`	`<Name>Feature File for Reqnroll</Name>`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-<?xml version="1.0" encoding="utf-8"?>`
	`1`	`+<?xml version="1.0" encoding="utf-8"?>`
`2`	`2`	`<VSTemplate Version="3.0.0" Type="Item" xmlns="http://schemas.microsoft.com/developer/vstemplate/2005">`
`3`	`3`	`<TemplateData>`
`4`	`4`	`<DefaultName>reqnroll.json</DefaultName>`