Skip to content
This repository has been archived by the owner on Jun 11, 2023. It is now read-only.

Commit

Permalink
#6 [doc] Write new concept about the basic class, interface structure…
Browse files Browse the repository at this point in the history
… in this library.
  • Loading branch information
Naoghuman committed Dec 2, 2018
1 parent 22c36cf commit 4dbb346
Show file tree
Hide file tree
Showing 2 changed files with 51 additions and 0 deletions.
50 changes: 50 additions & 0 deletions concept/Concept_Library_v0.2.0-PRERELEASE_2018-12-02.txt
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.

--------------------------------------------------------------------------------

1 change: 1 addition & 0 deletions release/Release_v0.2.0-PRERELEASE_2018-12-dd_HH-mm.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,7 @@ TODO


#### Documentation
#6 [doc] Write new concept about the basic class, interface structure in this library.



Expand Down

0 comments on commit 4dbb346

Please sign in to comment.