Conversation
Coverage Report for CI Build 35327547649Coverage increased (+0.02%) to 74.176%Details
Uncovered ChangesNo uncovered changes found. Coverage Regressions1 previously-covered line in 1 file lost coverage.
Coverage Stats💛 - Coveralls |
JoelAdbu
left a comment
There was a problem hiding this comment.
Thank you @gkenstel for separating these two documentations. I know this is outside the scope of your PR, but since we are already updating the documentation, I think it would make sense to include these two small improvements as well.
| To test the UrlUpdater, you can run in addition to the unit test the `UpdateInitiator` class located in `url-updater/src/main/java/com/devonfw/tools/ide/url/updater/UpdateInitiator.java` which allows you to run the updater and see the discovered versions and URLs in the console. | ||
| The arguments to pass are: | ||
|
|
||
| * Path to ide-urls project (where the url-updater module is located) | ||
| * Time to wait for the updater to finish (e.g., PT1H) | ||
| * Name of the updater to run (e.g., mytool) | ||
|
|
||
| Once a day, the `UpdateInitiator` will run the updaters through GitHub Actions and fill the https://github.com/devonfw/ide-urls[ide-URL] repository with new version/tools that are identified by the Updaters. |
There was a problem hiding this comment.
We should update this section as well. There is actually one additional step required: UpdateInitiator expects a fourth argument, namely the path to the ide-urls-status repository, which is passed as the second argument.
| Once a day, the `UpdateInitiator` will run the updaters through GitHub Actions and fill the https://github.com/devonfw/ide-urls[ide-URL] repository with new version/tools that are identified by the Updaters. | |
| To test the UrlUpdater, you can run in addition to the unit test the `UpdateInitiator` class located in `url-updater/src/main/java/com/devonfw/tools/ide/url/updater/UpdateInitiator.java` which allows you to run the updater and see the discovered versions and URLs in the console. | |
| Before running the updater, make sure the `ide-urls-status` repository is available under `project/_ide`. If it does not exist yet, clone it first. | |
| The arguments to pass are: | |
| * Path to ide-urls project (where the url-updater module is located) | |
| * Path to ide-urls-status project | |
| @@ -203,21 +128,3 @@ | |
| * Name of the updater to run (e.g., mytool) | |
| Once a day, the `UpdateInitiator` will run the updaters through GitHub Actions and fill the https://github.com/devonfw/ide-urls[ide-URL] repository with new version/tools that are identified by the Updaters. |
| For an example of the required files, you can check the tests of other commandlets with the same base class). | ||
| * Proper help texts for all supported languages are added in `cli/src/main/resources/nls/` (`Help.properties`, `Help_de.properties`). | ||
| * The new tool is added to the table of tools in LICENSE.asciidoc with the correct license information and tags. | ||
|
|
There was a problem hiding this comment.
This might be useful to add. Quite often, developers implement the UrlUpdater and immediately start working on the corresponding Commandlet before the UrlUpdater itself has been merged.
In that situation, being able to test the Commandlet locally is very helpful, so I think adding this note would make sense.
| === Test a Commandlet locally (before the UrlUpdater is merged) | |
| You can test a new Commandlet locally even if the corresponding UrlUpdater has not yet been merged. | |
| Create a branch containing both your Commandlet changes and the UrlUpdater changes. Then follow the steps described in `url-updater.adoc` to run the `UpdateInitiator`. | |
| 1. Ensure that `ide-urls-status` is cloned under `projects/_ide`. | |
| 2. Create and checkout a dedicated branch in `urls`. | |
| 3. Run the `UpdateInitiator` as described in `url-updater.adoc`. | |
| 4. Commit the generated changes in `urls`. | |
| 5. Run `ide install <tool>` or `ide new <tool>` to test the Commandlet. | |
| >[!Important] | |
| Commit the generated changes before running ide install <tool> or ide new <tool>. Otherwise, the generated content may be discarded, and the Commandlet cannot be tested locally. |
This PR fixes TodoIssueID
Implemented changes:
splitted documentation of commandlets and urlupdaters into seperated files.
Checklist for this PR
Make sure everything is checked before merging this PR. For further info please also see
our DoD.
mvn clean testlocally all tests pass and build is successful#«issue-id»: «brief summary»(e.g.#921: fixed setup.batand notfeature/921 fixed setup.bat). If no issue ID exists, title only.In Progressand assigned to you or there is no issue (might happen for very small PRs)with
internalpom.xmlfiles or otherwise if runtime dependencies changed, you have updated our LICENSE.asciidocChecklist for tool commandlets
Have you added a new
«tool»as commandlet? There are the following additional checks:«tool»«TOOL»_VERSIONand«TOOL»_EDITIONare honored by your commandlet