ishangsf/rspec
2
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

RULEAPI-621 Rename commands "gh_generate" and "gh_update" to "generate" and "update"

Browse Source
This commit is contained in:
Amélie Renard 2021-06-04 09:27:32 +02:00 committed by GitHub
parent 965a2e4592
commit c31c51e655
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 4 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
README.adoc
View File

@ -156,18 +156,18 @@ And finally, merge the rule implementation in your analyzer repository.
==== Generate/Update rule metadata for the analyzer
* Download the last version of https://github.com/SonarSource/sonar-rule-api[rule-api].
* call `gh_generate` if you are adding a rule, or `gh_update` if you just want the last specification version.
* call `generate` if you are adding a rule, or `update` if you just want the last specification version.
Example:
[source,shell]
----
$ java -jar rule-api-1.24.3.jar gh_generate -rule S4328
$ java -jar rule-api-1.24.3.jar generate -rule S4328
# or
$ java -jar rule-api-1.24.3.jar gh_update
$ java -jar rule-api-1.24.3.jar update
----
NOTE: If you generate rules in an empty directory,
you have to run `gh_update` immediately after,
you have to run `update` immediately after,
because rule-api relies on the files in the directory to determine the covered set of rules
when generating the deprecation notes for superseded rules.