Documentation: Add README file about how artifacts version is set in the pipeline #9148

mary-georgiou-sonarsource · 2024-04-19T13:37:56Z

No description provided.

sonarcloud · 2024-04-19T14:21:42Z

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
No data about Coverage
No data about Duplication

See analysis details on SonarCloud

pavel-mikula-sonarsource

We probably need to pair to build a basic outline first.

The story describes individual details, but I don't explain the overal picture, like what are the entrypoints.

pavel-mikula-sonarsource · 2024-04-23T08:24:23Z

scripts/version/set-version.ps1

@@ -3,6 +3,8 @@
 .SYNOPSIS
 This script allows to set the specified version in all required files.

+See in .\scripts\version\README how version is set during the pipeline run


DOES IT NEED TO YELL IN ALL CAPS?

Suggested change

See in .\scripts\version\README how version is set during the pipeline run

See in .\scripts\version\ReadMe.md how version is set during the pipeline run

the file is in capital README.md, I followed the pattern of other README.md.

Read-me files are usually overlooked, so they have to scream to get your attention 😱 .

PS: I added the md

pavel-mikula-sonarsource · 2024-04-23T08:28:16Z

scripts/version/README.md

+
+1. `sonar-csharp-plugin-x.y.z.buildNumber.jar`
+1. `sonar-vbnet-plugin-x.y.z.buildNumber.jar`
+1. `SonarAnalyzer.CSharp-x.y.z.nupkg`


SonarAnalyzer.CSharp.Styling is missing

pavel-mikula-sonarsource · 2024-04-23T08:28:29Z

scripts/version/README.md

+
+1. `sonar-csharp-plugin-x.y.z.buildNumber.jar`
+1. `sonar-vbnet-plugin-x.y.z.buildNumber.jar`
+1. `SonarAnalyzer.CSharp-x.y.z.nupkg`


There's no dash in nugets

Suggested change

1. `SonarAnalyzer.CSharp-x.y.z.nupkg`

1. `SonarAnalyzer.CSharp.x.y.z.nupkg`

pavel-mikula-sonarsource · 2024-04-23T08:29:23Z

scripts/version/README.md

+
+### How is the version set for the *.jar artifacts
+
+The Java artifacts' major, minor and, patch parts of the version, are set in the [sonar-dotnet pom.xml](https://github.com/SonarSource/sonar-dotnet/blob/master/pom.xml#L14).


Suggested change

The Java artifacts' major, minor and, patch parts of the version, are set in the [sonar-dotnet pom.xml](https://github.com/SonarSource/sonar-dotnet/blob/master/pom.xml#L14).

The Java artifacts' major, minor, and patch parts of the version, are set in the [sonar-dotnet pom.xml](https://github.com/SonarSource/sonar-dotnet/blob/master/pom.xml#L14).

pavel-mikula-sonarsource · 2024-04-23T08:30:19Z

scripts/version/README.md

+
+### How is the version set for the *.jar artifacts
+
+The Java artifacts' major, minor and, patch parts of the version, are set in the [sonar-dotnet pom.xml](https://github.com/SonarSource/sonar-dotnet/blob/master/pom.xml#L14).


The #L14 link will get easily out of date, as we won't backtrack this reference if we do any changes to the pom.xml. Permanent link would be better IMO

pavel-mikula-sonarsource · 2024-04-23T11:06:52Z

scripts/version/README.md

+The Java artifacts' major, minor and, patch parts of the version, are set in the [sonar-dotnet pom.xml](https://github.com/SonarSource/sonar-dotnet/blob/master/pom.xml#L14).
+The `buildNumber` is set in the Azure pipeline [here](https://github.com/SonarSource/sonar-dotnet/blob/master/azure-pipelines.yml#L538) with the use of the `update-maven-version-steps.yml` and it's equal to the pipeline [`buildId`](https://learn.microsoft.com/en-us/azure/devops/pipelines/process/run-number?view=azure-devops&tabs=yaml#tokens).
+
+You can find the `update-maven-version-steps.yml` [here](https://dev.azure.com/sonarsource/DotNetTeam%20Project/_git/pipelines-yaml-templates?path=/update-maven-version-steps.yml).


This paragraph should mention that maven set-version plugin is used to update all pom.xml files.

pavel-mikula-sonarsource · 2024-04-23T11:08:24Z

scripts/version/README.md

+
+### How is the version set for the *.jar artifacts
+
+The Java artifacts' major, minor and, patch parts of the version, are set in the [sonar-dotnet pom.xml](https://github.com/SonarSource/sonar-dotnet/blob/master/pom.xml#L14).


This is not entirely true. The actual version for JAR is inside sonar-csharp-plugin and sonar-vbnet-plugin pom.xml. It should mention that version is updated in all pom.xml files in the repo. See https://github.com/SonarSource/sonar-dotnet/pull/9076/files

Isn't the jar versions set from the parent pom that is in the root?
That's my understanding of the parent tag here.

We set this manually, as the version tag in the parent has to agree with the parent pom to be able to build. But the version is inherited from the parent. Do I get something wrong here?
I also just tested this in the pipeline.

pavel-mikula-sonarsource · 2024-04-23T11:08:50Z

scripts/version/README.md

+
+### How is the version set for the for the NuGet and the *.dll artifacts
+
+The major, minor and, patch parts of the version for these files is taken from the [`MainVersion` field in the Version.props](https://github.com/SonarSource/sonar-dotnet/blob/master/scripts/version/Version.props#L3) file. 


Suggested change

The major, minor and, patch parts of the version for these files is taken from the [`MainVersion` field in the Version.props](https://github.com/SonarSource/sonar-dotnet/blob/master/scripts/version/Version.props#L3) file.

The major, minor, and patch parts of the version for these files is taken from the [`MainVersion` field in the Version.props](https://github.com/SonarSource/sonar-dotnet/blob/master/scripts/version/Version.props#L3) file.

pavel-mikula-sonarsource · 2024-04-23T11:09:56Z

scripts/version/README.md

+You can find the `update-maven-version-steps.yml` [here](https://dev.azure.com/sonarsource/DotNetTeam%20Project/_git/pipelines-yaml-templates?path=/update-maven-version-steps.yml).
+The `buildNumber` is set on line 16 where the `compute-build-version-step.yml` is called, which you can find [here](https://dev.azure.com/sonarsource/DotNetTeam%20Project/_git/pipelines-yaml-templates?path=/compute-build-version-step.yml).
+
+### How is the version set for the for the NuGet and the *.dll artifacts


The whole story should start with set-version.ps1 as the entry point and then evolve into details. Now it's not clear that the main version comes from an argument there, and the rest of the story just randomly tasks other variables from Azure

pavel-mikula-sonarsource · 2024-04-23T11:11:00Z

scripts/version/README.md

+- [NuGet package metadata for `SonarAnalyzer.VisualBasic-x.y.z.nupkg`](https://github.com/SonarSource/sonar-dotnet/blob/master/analyzers/packaging/SonarAnalyzer.VisualBasic.nuspec)
+- [NuGet package metadata for `SonarAnalyzer.CFG-x.y.z.nupkg`](https://github.com/SonarSource/sonar-dotnet/blob/master/analyzers/src/SonarAnalyzer.CFG/SonarAnalyzer.CFG.cs.nuspec)
+
+is automatically updated through the [`ChangeVersion.proj`](https://github.com/SonarSource/sonar-dotnet/blob/master/scripts/version/ChangeVersion.proj) that is executed [here](https://github.com/SonarSource/sonar-dotnet/blob/master/azure-pipelines.yml#L91).


This story reads out of order. It doesn't follow the logical flow of operations.

sonarcloud · 2024-04-29T13:12:30Z

Quality Gate passed for 'Sonar .NET Java Plugin'

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
No data about Coverage
No data about Duplication

See analysis details on SonarCloud

sonarcloud · 2024-04-29T13:18:00Z

Quality Gate passed for 'SonarAnalyzer for .NET'

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
No data about Coverage
No data about Duplication

See analysis details on SonarCloud

mary-georgiou-sonarsource marked this pull request as draft April 19, 2024 13:38

github-actions bot assigned mary-georgiou-sonarsource Apr 19, 2024

github-actions bot added this to In progress in Best Kanban Apr 19, 2024

mary-georgiou-sonarsource force-pushed the mary/doc-versioning branch 6 times, most recently from b63a7cb to e0e675e Compare April 19, 2024 14:06

mary-georgiou-sonarsource changed the title ~~document versioning~~ Documentation: Add README file describing how artifacts version is set in the pipeline Apr 19, 2024

mary-georgiou-sonarsource changed the title ~~Documentation: Add README file describing how artifacts version is set in the pipeline~~ Documentation: Add README file about how artifacts version is set in the pipeline Apr 19, 2024

mary-georgiou-sonarsource added the documentation label Apr 19, 2024

mary-georgiou-sonarsource marked this pull request as ready for review April 19, 2024 14:09

mary-georgiou-sonarsource requested a review from pavel-mikula-sonarsource April 19, 2024 14:11

github-actions bot assigned pavel-mikula-sonarsource and unassigned mary-georgiou-sonarsource Apr 19, 2024

github-actions bot moved this from In progress to Review in progress in Best Kanban Apr 19, 2024

pavel-mikula-sonarsource removed the documentation label Apr 23, 2024

pavel-mikula-sonarsource requested changes Apr 23, 2024

View reviewed changes

github-actions bot assigned mary-georgiou-sonarsource and unassigned pavel-mikula-sonarsource Apr 23, 2024

github-actions bot moved this from Review in progress to In progress in Best Kanban Apr 23, 2024

document versioning

30d2736

mary-georgiou-sonarsource force-pushed the mary/doc-versioning branch 6 times, most recently from 9098cc5 to 24d38af Compare April 29, 2024 08:12

mary-georgiou-sonarsource force-pushed the mary/doc-versioning branch from 609eafe to 93279c9 Compare April 29, 2024 08:22

Add comment to set-version script

93279c9

mary-georgiou-sonarsource force-pushed the mary/doc-versioning branch 5 times, most recently from 502af83 to 6a1a3c0 Compare April 29, 2024 13:05

refactor - apply comments

6a1a3c0

mary-georgiou-sonarsource requested a review from pavel-mikula-sonarsource April 29, 2024 13:05

github-actions bot assigned pavel-mikula-sonarsource and unassigned mary-georgiou-sonarsource Apr 29, 2024

github-actions bot moved this from In progress to Review in progress in Best Kanban Apr 29, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Documentation: Add README file about how artifacts version is set in the pipeline #9148

Documentation: Add README file about how artifacts version is set in the pipeline #9148

mary-georgiou-sonarsource commented Apr 19, 2024 •

edited

sonarcloud bot commented Apr 19, 2024

pavel-mikula-sonarsource left a comment

pavel-mikula-sonarsource Apr 23, 2024

mary-georgiou-sonarsource Apr 29, 2024 •

edited

pavel-mikula-sonarsource Apr 23, 2024

pavel-mikula-sonarsource Apr 23, 2024

pavel-mikula-sonarsource Apr 23, 2024

pavel-mikula-sonarsource Apr 23, 2024

pavel-mikula-sonarsource Apr 23, 2024

pavel-mikula-sonarsource Apr 23, 2024

mary-georgiou-sonarsource Apr 29, 2024

pavel-mikula-sonarsource Apr 23, 2024

pavel-mikula-sonarsource Apr 23, 2024

pavel-mikula-sonarsource Apr 23, 2024

sonarcloud bot commented Apr 29, 2024

sonarcloud bot commented Apr 29, 2024

	See in .\scripts\version\README how version is set during the pipeline run
	See in .\scripts\version\ReadMe.md how version is set during the pipeline run

	1. `SonarAnalyzer.CSharp-x.y.z.nupkg`
	1. `SonarAnalyzer.CSharp.x.y.z.nupkg`


		### How is the version set for the *.jar artifacts

		The Java artifacts' major, minor and, patch parts of the version, are set in the [sonar-dotnet pom.xml](https://github.com/SonarSource/sonar-dotnet/blob/master/pom.xml#L14).

	The Java artifacts' major, minor and, patch parts of the version, are set in the [sonar-dotnet pom.xml](https://github.com/SonarSource/sonar-dotnet/blob/master/pom.xml#L14).
	The Java artifacts' major, minor, and patch parts of the version, are set in the [sonar-dotnet pom.xml](https://github.com/SonarSource/sonar-dotnet/blob/master/pom.xml#L14).


		### How is the version set for the for the NuGet and the *.dll artifacts

		The major, minor and, patch parts of the version for these files is taken from the [`MainVersion` field in the Version.props](https://github.com/SonarSource/sonar-dotnet/blob/master/scripts/version/Version.props#L3) file.

	The major, minor and, patch parts of the version for these files is taken from the [`MainVersion` field in the Version.props](https://github.com/SonarSource/sonar-dotnet/blob/master/scripts/version/Version.props#L3) file.
	The major, minor, and patch parts of the version for these files is taken from the [`MainVersion` field in the Version.props](https://github.com/SonarSource/sonar-dotnet/blob/master/scripts/version/Version.props#L3) file.

Documentation: Add README file about how artifacts version is set in the pipeline #9148

Are you sure you want to change the base?

Documentation: Add README file about how artifacts version is set in the pipeline #9148

Conversation

mary-georgiou-sonarsource commented Apr 19, 2024 • edited

sonarcloud bot commented Apr 19, 2024

Quality Gate passed

pavel-mikula-sonarsource left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

mary-georgiou-sonarsource Apr 29, 2024 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

sonarcloud bot commented Apr 29, 2024

Quality Gate passed for 'Sonar .NET Java Plugin'

sonarcloud bot commented Apr 29, 2024

Quality Gate passed for 'SonarAnalyzer for .NET'

mary-georgiou-sonarsource commented Apr 19, 2024 •

edited

mary-georgiou-sonarsource Apr 29, 2024 •

edited