Swordsteel
b6b0252975
- update release in README.md - add action run checks - add action release - remove release.sh
57 lines
2.7 KiB
Markdown
57 lines
2.7 KiB
Markdown
# Hlæja Common Messages
|
|
|
|
In quiet chambers of learning, where minds are aglow, A ledger of endorsements, the authenticity to bestow. Each certificate approved, with scrutiny and might, Their legitimacy confirmed, in the light of day and night. From manuscripts to databases, knowledge is refined, Librarians and experts, their judgment to define. The Approval Archive, a sacred trust to hold, A testament to credentials, where merit is told.
|
|
|
|
## Properties
|
|
|
|
The following properties can be used to configure the deployment of your application. If specified, these properties will load their respective services.
|
|
|
|
| name | info |
|
|
|-----------------|------------------------------------------------------------------------------------------------------------------------------------------------------|
|
|
| jwt.private-key | Location of the private key file. If specified, the `PrivateJwtService` will be loaded with the provided private key for signing purposes. |
|
|
| jwt.public-key | Location of the public key file. If specified, the `PublicJwtService` service will be loaded with the provided public key for verification purposes. |
|
|
|
|
**Note:** The `jwt.private-key` and `jwt.public-key` properties are optional and correspond to separate services: `PrivateJwtService` and `PublicJwtService`, respectively. If either property is specified, its corresponding service will be loaded. For example:
|
|
|
|
- Specifying only `jwt.private-key` will load the `PrivateJwtService` for signing purposes.
|
|
- Specifying only `jwt.public-key` will load the `PublicJwtService` for verification purposes.
|
|
- Specifying both properties will enable both services, allowing for full JWT functionality with authentication and authorization.
|
|
|
|
## Releasing library
|
|
|
|
Run release pipeline from `master` branch.
|
|
|
|
## Publishing library
|
|
|
|
### Publish library locally
|
|
|
|
```shell
|
|
./gradlew clean build publishToMavenLocal
|
|
```
|
|
|
|
### Publish library to repository
|
|
|
|
```shell
|
|
./gradlew clean build publish
|
|
```
|
|
|
|
### Global Settings
|
|
|
|
This services rely on a set of global settings to configure development environments. These settings, managed through Gradle properties or environment variables.
|
|
|
|
*Note: For more information on global properties, please refer to our [global settings](https://github.com/swordsteel/hlaeja-development/blob/master/doc/global_settings.md) documentation.*
|
|
|
|
#### Gradle Properties
|
|
|
|
```properties
|
|
repository.user=your_user
|
|
repository.token=your_token_value
|
|
```
|
|
|
|
#### Environment Variables
|
|
|
|
```properties
|
|
REPOSITORY_USER=your_user
|
|
REPOSITORY_TOKEN=your_token_value
|
|
```
|