Merge pull request #1362 from okorach:fix-sonar-migration-doc-links

sonar-migration own doc

Author: okorach

doc/README.sonar-migration.md

@@ -12,6 +12,8 @@ Command line tool to collect SonarQube data to prepare eventual migration to Son
 [![Bugs](https://sonarcloud.io/api/project_badges/measure?project=okorach_sonar-tools&metric=bugs)](https://sonarcloud.io/dashboard?id=okorach_sonar-tools)
 [![Lines of Code](https://sonarcloud.io/api/project_badges/measure?project=okorach_sonar-tools&metric=ncloc)](https://sonarcloud.io/dashboard?id=okorach_sonar-tools)
 
+[What's new](https://github.com/okorach/sonar-tools/blob/master/doc/what-is-new.sonar-migration.md)
+
 **DISCLAIMER**: This software is community software.
 
 

doc/what-is-new.sonar-migration.md

@@ -0,0 +1,41 @@
+# Next version yet unreleased
+
+# Version 0.2
+
+- Added export of:
+  - Users email and SCM accounts when available
+  - Users last SonarQube and SonarLint login date
+  - Per project:
+    - Issues coming from instantiated rules (e.g. custom secrets)
+    - Hotspots which have been reviewed as SAFE or FIXED
+- sonar-migration has its own user agent to be recongnized in SonarQune access.log
+- Added check whether the running version is the last released
+- Fixed crash when accessing a portfolio with not enough permissions
+- `sonar-migration` now has its own doc pages (readme and what's new)
+
+# Version 0.1
+
+- First alpha release
+- On top of the regular `sonar-config` export the follwoing is added
+  - Global:
+    - List of 3rd party plugins installed
+  - Per project
+    - Last analysis date
+    - Ncloc w/ breakdown by language
+    - Detected CI
+    - Main branch revision
+    - Last background task scanner context and warnings
+    - Background Task history
+    - Issues:
+      - # of issue False positive
+      - # of issues Won’t fix
+      - # of issues Accepted
+      - # of issues generated by 3rd party rules (with breakdown per rule)
+    - For each branch:
+    - Last analysis date
+    - Ncloc w/ breakdown by language
+    - Issues
+      - # of issue False positive
+      - # of issues Won’t fix
+      - # of issues Accepted
+      - # of issues generated by 3rd party rules (with breakdown per rule)

setup_migration.py

@@ -40,7 +40,7 @@
     url="https://github.com/okorach/sonar-tools",
     project_urls={
         "Bug Tracker": "https://github.com/okorach/sonar-tools/issues",
-        "Documentation": "https://github.com/okorach/sonar-tools/README.md",
+        "Documentation": "https://github.com/okorach/sonar-tools/doc/README.sonar-migration.md",
         "Source Code": "https://github.com/okorach/sonar-tools",
     },
     packages=setuptools.find_packages(),

sonar_migration

@@ -28,5 +28,5 @@ sonar-migration version {version.PACKAGE_VERSION}
 
 run: sonar-migration -u <SonarQubeURL> -t <SonarAdminUserToken>
 
-See tools built-in -h help and https://github.com/okorach/sonar-tools for more documentation
+See tools built-in -h help and https://github.com/okorach/sonar-tools/doc/README.sonar-migration.md for more documentation
 ''')