diff options
| author | Thomas <> | 2022-08-22 11:49:32 +0200 |
|---|---|---|
| committer | Thomas <> | 2022-08-22 11:49:32 +0200 |
| commit | a5a3a527cdcc74bcb10fae7ef179551c7161f9ee (patch) | |
| tree | c0f82875cf1dc88abe93af99e9c18af48cac0b55 /README.md | |
| parent | 0db117e2340494242e2234b6c113be5ed2c63cf6 (diff) | |
| download | National_eIDAS_Gateway-a5a3a527cdcc74bcb10fae7ef179551c7161f9ee.tar.gz National_eIDAS_Gateway-a5a3a527cdcc74bcb10fae7ef179551c7161f9ee.tar.bz2 National_eIDAS_Gateway-a5a3a527cdcc74bcb10fae7ef179551c7161f9ee.zip | |
doc: update and add readmes, handbooks, and release infos
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 35 |
1 files changed, 31 insertions, 4 deletions
@@ -6,7 +6,7 @@ The member-state specific eIDAS application (ms-specific eIDAS) implements the b - **MS-specific Connector:** implements the bridge to connect a national service-provider to a foreign idenity-provider. -- **MS-specific Proxy-Service:** implements the bridge to connect a foreign service-provider to national eID system (ID Austria). This feature is not implemented yet. +- **MS-specific Proxy-Service:** implements the bridge to connect a foreign service-provider to national eID system (ID Austria). @@ -52,15 +52,35 @@ In case of a executable application package, the configuration can be either set A default configuration is located at _basicConfig/_ +**Hint:** The project includes the MS eIDAS-Connector and the MS eIDAS-Proxy-Service and defines separate configuration, handbook, and release notes for each application. + + + ## Generate a BM.I Release Package The full release packages for BM.I infrastructure will be automatically assembled by maven build-process. Before release build, all release related information have to added into infos folder. To add release informations follow the steps outlined below. +**Hint:** The project includes the *MS eIDAS-Connector* and the *MS eIDAS-Proxy-Service* and defines separate configuration, handbook, and release notes for each application. + +Define release version for *MS eIDAS-Connector* and *MS eIDAS-Proxy-Service* in: + +``` +./pom.xml + +<ms_specific_connector.version> SET_VERSION_FOR_CONNECTOR </ms_specific_connector.version> +<ms_specific_proxyservice> SET_VERSION_FOR_MS_PROXY </ms_specific_proxyservice> + +``` + + + Add a file with release informations to: + ``` -./infos/readme_{version}.txt +./infos/ms-connector/readme_{version}.txt +./infos/ms-proxyservice/readme_{version}.txt ``` Add additional eIDAS Node related information into: @@ -72,10 +92,16 @@ Add additional eIDAS Node related information into: Add, remove, or update the application description in the handbook and store the handbook for the current release version as pdf. ``` -modify: ./infos/handbook-work_in_progress.docx -store pdf to: ./infos/handbook/handbook-{version}.pdf +modify: ./infos/ms-connector/Handbuch_MS-eIDAS-Node.docx +store pdf to: ./infos/ms-connector/handbook/handbook-{version}.pdf ``` +``` +modify: ./infos/ms-proxyservice/Handbuch_MS-eIDAS-Proxy-Service.docx +store pdf to: ./infos/ms-proxyservice/handbook/handbook-{version}.pdf +``` + + Generate a release package with: @@ -86,6 +112,7 @@ mvn clean package The full release package will be located add ``` ./target/ms_specific_connector-{version}-dist.tar.gz +./target/ms_specific_proxyservice-{version}-dist.tar.gz ``` |