Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: update README related to changes to release and versioning #159

Merged
merged 1 commit into from
Nov 27, 2024
Merged

docs: update README related to changes to release and versioning #159

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
32 changes: 12 additions & 20 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,21 +22,25 @@ For a quick start, check out the (outdated) [sample project on GitHub](https://g
Usage
-----

The simplest way to apply the plugin to your Gradle build is using the latest release hosted on Maven Central:
The simplest way to apply the plugin to your Gradle build is using the latest release on the [Gradle Plugin Portal](https://plugins.gradle.org/plugin/org.standardout.bnd-platform).

The plugin is also hosted on Maven Central:

```groovy
buildscript {
repositories {
mavenCentral()
}
dependencies {
classpath 'org.standardout:bnd-platform:3.0.1'
classpath 'org.standardout:bnd-platform:<version>'
}
}

apply plugin: 'org.standardout.bnd-platform'
```

You can look up the latest release version in the [GitHub releases](https://github.com/stempler/bnd-platform/releases).

Alternatives are including the repository content in the **buildSrc** folder as done in the [sample project](https://github.com/stempler/bnd-platform-sample) or by installing the plugin to your local Maven repository using `gradlew install` and adding it as dependency to your build script via `mavenLocal()` repository.

Snapshot versions are available in the related sonatype repository:
Expand All @@ -50,13 +54,18 @@ buildscript {
}
}
dependencies {
classpath 'org.standardout:bnd-platform:3.1.0-SNAPSHOT'
classpath 'org.standardout:bnd-platform:<version>'
}
}

apply plugin: 'org.standardout.bnd-platform'
```

The latest snapshot version can be found in the [Sonatype repository](https://oss.sonatype.org/content/repositories/snapshots/org/standardout/bnd-platform/).

If changes were made after the last release, the snapshot version is the last release version with the minor version number increased by one and the qualifier set to `-SNAPSHOT`.
For example, for the 3.1.0 release the snapshot version would be 3.2.0-SNAPSHOT.


### Tasks

Expand Down Expand Up @@ -521,23 +530,6 @@ platform {
}
```



Release
-------

Releases are currently not done by the CI but manually.

Steps are:

1. Change version to release version
2. Adapt changelog
3. Create tag
4. Publish release to Maven Central (`./gradlew publishToSonatype closeAndReleaseSonatypeStagingRepository`)
5. Publish release to Gradle Plugin Portal
6. Change version to new snapshot


License
-------

Expand Down