Skip to content

Commit

Permalink
docs: update README
Browse files Browse the repository at this point in the history
- Add minimal release documentation
- Strip duplicate documentation for using SNAPSHOT
  • Loading branch information
stempler committed Oct 23, 2023
1 parent 234f404 commit 5b38883
Showing 1 changed file with 10 additions and 18 deletions.
28 changes: 10 additions & 18 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ Even worse, sometimes you need to adapt bundles due to class loading issues or m
*bnd-platform* can help you solve that problem - it builds OSGi bundles and even Eclipse Update Sites from existing JARs, for instance retrieved from Maven repositories together with transitive dependencies. If needed you can adapt the creation of bundles via general or individual configuration options.
*bnd-platform* is a [Gradle](http://www.gradle.org/) plugin and uses [bnd](http://www.aqute.biz/Bnd/Bnd) to create bundles and [Eclipse](http://www.eclipse.org/) for the creation of p2 repositories.

For a quick start, check out the [sample project on GitHub](https://github.com/stempler/bnd-platform-sample) or use [this minimal example](https://github.com/stempler/bnd-platform-minimal) as a template for your build.
For a quick start, check out the (outdated) [sample project on GitHub](https://github.com/stempler/bnd-platform-sample) or use [this minimal example](https://github.com/stempler/bnd-platform-minimal) as a template for your build.

**What *bnd-platform* can do:**
* Create bundles for any JARs that can be defined as dependencies using Gradle (e.g. local JARs, JARs from Maven repositories) and their transitive dependencies
Expand Down Expand Up @@ -498,26 +498,18 @@ platform {



Using the current SNAPSHOT
--------------------------
Release
-------

If you want to test the latest version with changes that have not been released yet, you can configure your project to use the latest SNAPSHOT:
Releases are currently not done by the CI but manually.

```groovy
buildscript {
repositories {
maven {
url 'http://oss.sonatype.org/content/repositories/snapshots/'
}
jcenter()
}
dependencies {
classpath 'org.standardout:bnd-platform:1.8.0-SNAPSHOT'
}
}
Steps are:

apply plugin: 'org.standardout.bnd-platform'
```
1. Change version to release version
2. Adapt changelog
3. Create tag
4. Publish release (`./gradlew publishToSonatype closeAndReleaseSonatypeStagingRepository`)
5. Change version to new snapshot


License
Expand Down

0 comments on commit 5b38883

Please sign in to comment.