Skip to content

Commit e5915c7

Browse files
Update README to remove JReleaser release details (#23)
Removed outdated information about JReleaser environment variables and release process. Signed-off-by: Hendrik Ebbers <hendrik.ebbers@open-elements.com>
1 parent b74ea90 commit e5915c7

1 file changed

Lines changed: 2 additions & 30 deletions

File tree

README.md

Lines changed: 2 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -174,39 +174,11 @@ spring.hiero.privateKey=2130020100312346052b8104400304220420c236508c429395a8180b
174174

175175
### Create a release
176176

177-
The project is using the [JReleaser](https://jreleaser.org) Maven plugin to create and publish releases.
178-
To use the plugin, you need to provide the following environment variables:
179-
180-
```
181-
JRELEASER_GITHUB_TOKEN=your_secret_github_token
182-
JRELEASER_GPG_SECRET_KEY=your_secret_key
183-
JRELEASER_GPG_PASSPHRASE=your_secret_passphrase
184-
JRELEASER_GPG_PUBLIC_KEY=yout_public_key
185-
JRELEASER_NEXUS2_MAVEN_CENTRAL_USERNAME=your_maven_central_username
186-
JRELEASER_NEXUS2_MAVEN_CENTRAL_TOKEN=your_secret_maven_central_token
187-
```
188-
189-
How that environment variables are defined can be found in the
190-
[JReleaser documentation](https://jreleaser.org/guide/latest/examples/maven/maven-central.html) and
191-
[this blog post](https://foojay.io/today/how-to-release-a-java-module-with-jreleaser-to-maven-central-with-github-actions/).
192-
193-
On a unix based system the environment variables can be defined in the `.env` file in the root of the project.
194-
The file is added to the `.gitignore` file and is not committed to the repository.
195-
196-
Once that is done you can use the `release.sh` script in the root folder of the repos to create a release:
197-
198-
```shell
199-
./release 0.1.0 0.2.0-SNAPSHOT
200-
```
201-
202-
This will create a release on GitHub and publish the artifacts to Maven Central.
203-
As you can see 2 params are passed to the `release.sh` script, The first param defines the version for the release and the second param defines the version after the release.
204-
In the given example the project has defined version 0.1.0-SNAPSHOT before the script is executed.
205-
The execution will release the current code under version 0.1.0 and later switch the version to 0.2.0-SNAPSHOT and commit it.
177+
Currently there is no running release process and we work on setting uop everything to do releases under the hiero-ledger org.
206178

207179
## Documentation
208180

209-
Technical documentation (getting started, architecture, Spring/MicroProfile, managed services, ADRs) is in the **[docs](docs/)** folder and is published as [GitHub Pages](https://hiero-ledger.github.io/hiero-enterprise-java/). Pull requests that change the docs get a preview at `…/pr/<number>/`. Set **Settings → Pages → Deploy from a branch** → branch: `gh-pages`, folder: `/ (root)`.
181+
Technical documentation (getting started, architecture, Spring/MicroProfile, managed services, ADRs) is in the **[docs](docs/)** folder and is published as [GitHub Pages](https://hiero-ledger.github.io/hiero-enterprise-java/). Pull requests that change the docs get a preview at `…/pr/<number>/`.
210182

211183
## License
212184

0 commit comments

Comments
 (0)