11# GitHub Actions Workflows Guide
22
3+ [ Back to README] ( ../README.md )
4+
35This document explains the GitHub Actions workflows used in the OpenMapView project.
46
57## Architecture Overview
@@ -131,19 +133,19 @@ build-library build-examples
131133
132134## Required GitHub Secrets
133135
134- For the release workflow to function, you must configure these secrets in your GitHub repository:
136+ For the release workflow to function, the project owner must configure these secrets in the GitHub repository:
135137
136138** Location** : Settings -> Secrets and variables -> Actions -> Repository secrets
137139
138140### 1. OSSRH_USERNAME
139- - ** Description** : Your Sonatype JIRA username
141+ - ** Description** : Sonatype JIRA username
140142- ** Used for** : Authenticating to Maven Central OSSRH
141- - ** How to get** : Created when you register at https://issues.sonatype.org
143+ - ** How to get** : Created when registering at https://issues.sonatype.org
142144
143145### 2. OSSRH_PASSWORD
144- - ** Description** : Your Sonatype JIRA password
146+ - ** Description** : Sonatype JIRA password
145147- ** Used for** : Authenticating to Maven Central OSSRH
146- - ** How to get** : Set when you register at https://issues.sonatype.org
148+ - ** How to get** : Set when registering at https://issues.sonatype.org
147149
148150### 3. SIGNING_KEY
149151- ** Description** : Base64-encoded GPG private key
@@ -156,10 +158,10 @@ For the release workflow to function, you must configure these secrets in your G
156158- ** Security** : Never commit this or share it publicly
157159
158160### 4. SIGNING_PASSWORD
159- - ** Description** : Passphrase for your GPG key
161+ - ** Description** : Passphrase for the GPG key
160162- ** Used for** : Unlocking the GPG private key for signing
161- - ** How to get** : The passphrase you set when creating your GPG key
162- - ** Note** : If you didn't set a passphrase , use an empty string
163+ - ** How to get** : The passphrase set when creating the GPG key
164+ - ** Note** : If no passphrase was set , use an empty string
163165
164166### Automatic Secrets
165167
@@ -172,7 +174,7 @@ These secrets are automatically provided by GitHub Actions:
172174
173175### Running CI Checks Locally
174176
175- Before pushing, you can run the same checks locally:
177+ Before pushing, developers can run the same checks locally:
176178
177179``` bash
178180# Format check
0 commit comments