Skip to content

Commit 0474069

Browse files
vdiezclaude
andauthored
SCANNPM-132 docs: Add Sonar Update Center release process (#398)
Co-authored-by: Claude Opus 4.5 <noreply@anthropic.com>
1 parent 272ea78 commit 0474069

File tree

1 file changed

+28
-0
lines changed

1 file changed

+28
-0
lines changed

docs/DEV.md

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -90,3 +90,31 @@ You can test the release workflow without actually publishing by using the manua
9090
- **Simulate [skip-latest]**: Check to test the skip-latest behavior
9191

9292
The workflow will run and display the npm tag that would be used without performing any actual build or publish operations.
93+
94+
### Sonar Update Center
95+
96+
After publishing a new release, the [Sonar Update Center](https://xtranet-sonarsource.atlassian.net/wiki/spaces/DOC/pages/3385294896/The+Sonar+Update+Center) needs to be updated. This makes release information available at `downloads.sonarsource.com` for documentation and tooling.
97+
98+
#### Update Process
99+
100+
1. **Create a PR** in [sonar-update-center-properties](https://github.com/SonarSource/sonar-update-center-properties) to update `scannernpm.properties`
101+
102+
2. **Add the new version entry** with the following format:
103+
104+
```properties
105+
X.Y.Z.description=Short description of the release
106+
X.Y.Z.date=YYYY-MM-DD
107+
X.Y.Z.changelogUrl=https://github.com/SonarSource/sonar-scanner-npm/releases/tag/X.Y.Z
108+
X.Y.Z.downloadUrl=https://www.npmjs.com/package/@sonar/scan/v/X.Y.Z
109+
```
110+
111+
3. **Update version lists**:
112+
- Move the previous public version to `archivedVersions`
113+
- Set the new version in `publicVersions`
114+
115+
4. **After PR is merged**, run the scanner release notes GitHub Action on the [SonarQube-Documentation](https://github.com/SonarSource/SonarQube-Documentation) repo to create a PR that pushes the update to product docs
116+
117+
#### Reference
118+
119+
- Initial setup PR: [sonar-update-center-properties#742](https://github.com/SonarSource/sonar-update-center-properties/pull/742)
120+
- Published JSON: `https://downloads.sonarsource.com/sonarqube/update/scannernpm.json`

0 commit comments

Comments
 (0)