This repository has been archived by the owner on Jun 11, 2023. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
#6 [doc] Write new concept about the basic class, interface structure…
… in this library.
- Loading branch information
Showing
2 changed files
with
51 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,50 @@ | ||
-------------------------------------------------------------------------------- | ||
CONCEPT Library v0.2.0-PRERELEASE | ||
-------------------------------------------------------------------------------- | ||
DESCRIPTION | ||
In this concept I want to update the concept for my new library 'Lib-Release' to | ||
v0.2.0-PRERELEASE. | ||
|
||
-------------------------------------------------------------------------------- | ||
API structure | ||
|
||
com.github.naoghuman.lib.release.core | ||
- Class ReleaseConfigurationBuilder | ||
- urlToGitHubProject(), | ||
- actualVersion(), | ||
- checkUpdateDuringStartup() | ||
- Class ReleaseFacade | ||
- Bundles all functionalities (expected builders) from the library. | ||
- Preferred way to access all functionalities (expected if builders exists). | ||
|
||
- Interface ReleaseClient | ||
- Infos about the actual version in the client (application). | ||
- Option to check during startup if the application is up-to-date. | ||
- Option to check manually if the application is up-to-date. | ||
- Interface ReleaseServerGitHub | ||
- URL to GitHub project. | ||
- Connect to github project last release (returned as json). | ||
- Opens a github last release url in common browser. | ||
- Extract infos from the json (see ReleaseGitHubConnection). | ||
- Extract the infos about the last release. | ||
- Extract the infos about the last release notes. | ||
- Extract the url to the last release download jar file. | ||
- Contains all methods to convert the 'markdown' release note to a 'html' note. | ||
- Special: #Nr will be convert to a link from the active GitHub project. | ||
|
||
com.github.naoghuman.lib.release.internal | ||
- Class DefaultReleaseClient | ||
- Implementation from the interface ReleaseClient | ||
- Class DefaultReleaseServerGitHub | ||
- Implementation from the interface ReleaseServerGitHub | ||
|
||
- Class DefaultReleaseValidator. | ||
- Contains basic validation methods for precondition checks. | ||
|
||
-------------------------------------------------------------------------------- | ||
EXTRAS | ||
- Document about the convention to access and extract the infos from my GitHub | ||
projects. | ||
|
||
-------------------------------------------------------------------------------- | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters