-
Notifications
You must be signed in to change notification settings - Fork 68
Add documentation about new commandlets and UrlUpdates #1949
Copy link
Copy link
Open
Labels
documentationImprovements or additions to documentationImprovements or additions to documentationenhancementNew feature or requestNew feature or requestinternalNothing to be added to CHANGELOG, only internal storyNothing to be added to CHANGELOG, only internal storyready-to-implementurlside-urls repo and related processes and featureside-urls repo and related processes and features
Metadata
Metadata
Assignees
Labels
documentationImprovements or additions to documentationImprovements or additions to documentationenhancementNew feature or requestNew feature or requestinternalNothing to be added to CHANGELOG, only internal storyNothing to be added to CHANGELOG, only internal storyready-to-implementurlside-urls repo and related processes and featureside-urls repo and related processes and features
Type
Fields
Give feedbackNo fields configured for Task.
Projects
Status
🆕 New
Task summary
We already discussed in the team that the documentation about creating new commandlets and UrlUpdaters is lacking. The knowledge in the team should be present but only in some heads so we need to write it down.
Important key facts:
Npm,Mvn,Pipwhere we have according implementations ofToolRepositoryand*BasedCommandlet(BTW: I just noticed that the naming is inconsistent and should be aligned - seeMvnBasedLocalToolCommandletvs.PipBasedCommandletvs.NpmBasedCommandlet). In case of such ecosystem noUrlUpdateris needed and not even wanted.UrlUpdateris needed explain what it is and what options and base-classes there are to implement one. E.g.WebsiteUrlUpdatershould be avoided (explain why it is unstable and kind of hacky) and is only used in the worst case where there really is no other option left. For GitHub explain thatGithubUrlReleaseUpdater(shouldn't it be consistently namedGithubReleaseUrlUpdater) is preferred if the tool provides releases on GitHub (explain how to find out). Only otherwise considerGithubUrlTagUpdater(rename toGithubTagUrlUpdater?).JsonUrlUpdaterif we find a REST+JSON API.Additional context
No response