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.

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

Prepare release #272

Merged
merged 3 commits into from
Jan 31, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
3 changes: 1 addition & 2 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -43,8 +43,7 @@ jobs:
- name: Check that workflows are up to date
run: sbt '++ ${{ matrix.scala }}' githubWorkflowCheck

- name: Build project
run: sbt '++ ${{ matrix.scala }}' test
- run: sbt '++ ${{ matrix.scala }}' test scripted

- name: Compress target directories
run: tar cf targets.tar target project/target
Expand Down
11 changes: 1 addition & 10 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,4 @@
# sbt-paradox-apidoc [![maven-central-badge][]][maven-central] [![github-actions-badge][]][github-actions]

[maven-central]: https://maven-badges.herokuapp.com/maven-central/com.lightbend.paradox/sbt-paradox-apidoc
[maven-central-badge]: https://maven-badges.herokuapp.com/maven-central/com.lightbend.paradox/sbt-paradox-apidoc/badge.svg
[github-actions]: https://github.com/lightbend/sbt-paradox-apidoc/actions/workflows/ci.yml?query=branch%3Amaster
[github-actions-badge]: https://github.com/lightbend/sbt-paradox-apidoc/actions/workflows/ci.yml/badge.svg?branch=master
# sbt-paradox-apidoc

A [paradox](https://github.com/lightbend/paradox/) directive that automatically adds links for classes from documentation to scaladoc and javadoc.

Expand Down Expand Up @@ -123,7 +118,3 @@ The license is Apache 2.0, see LICENSE.
## Maintanance notes

**This project is NOT supported under the Lightbend subscription.**

The project is maintained mostly by [@richardimaoka](https://github.com/richardimaoka) and [@akka-team](https://github.com/orgs/lightbend/teams/akka-team/members).

Feel free to ping above maintainers for code review or discussions. Pull requests are very welcome–thanks in advance!
9 changes: 3 additions & 6 deletions RELEASING.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,5 @@
# Releasing

Releasing from CI was removed as Bintray passed away.

1. Wait until all running [Travis CI jobs](https://travis-ci.org/lightbend/sbt-paradox-apidoc/builds) complete, if any.
1. Fix up the [draft release](https://github.com/lightbend/sbt-paradox-apidoc/releases) created by the release drafter and set the next tag version (e.g. `v0.2`)
1. Ensure you're on JDK 8
1. Pull the tag, build and publish the release to Sonatype
* Draft a [new release on GitHub](https://github.com/lightbend/sbt-paradox-apidoc/releases)
* Tag it (with a `v` prefix)
* Github actions should automatically release to maven-central
8 changes: 3 additions & 5 deletions build.sbt
Original file line number Diff line number Diff line change
Expand Up @@ -52,14 +52,12 @@ ThisBuild / githubWorkflowPublish := Seq(
)
)

ThisBuild / publishMavenStyle := true
ThisBuild / publishTo := sonatypePublishTo.value
ThisBuild / test / publishArtifact := false
ThisBuild / pomIncludeRepository := (_ => false)
sonatypeProfileName := "com.lightbend"
ThisBuild / publishTo := sonatypePublishTo.value
sonatypeProfileName := "com.lightbend"

ThisBuild / githubWorkflowJavaVersions := List(
JavaSpec.temurin("11")
)

ThisBuild / githubWorkflowTargetBranches := Seq("main")
ThisBuild / githubWorkflowBuild := Seq(WorkflowStep.Sbt(List("test", "scripted")))
2 changes: 1 addition & 1 deletion project/Dependencies.scala
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,6 @@ import sbt._
object Library {
val classgraph = "io.github.classgraph" % "classgraph" % "4.8.165"
val sbtParadox = "com.lightbend.paradox" % "sbt-paradox" % "0.10.6"
val scalatest = "org.scalatest" %% "scalatest" % "3.2.14"
val paradoxTestkit = "com.lightbend.paradox" %% "testkit" % "0.10.6"
val scalatest = "org.scalatest" %% "scalatest" % "3.2.17"
}
2 changes: 1 addition & 1 deletion project/plugins.sbt
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
addSbtPlugin("de.heikoseeberger" % "sbt-header" % "5.10.0")
addSbtPlugin("org.scalameta" % "sbt-scalafmt" % "2.4.6")
addSbtPlugin("org.scalameta" % "sbt-scalafmt" % "2.5.2")
addSbtPlugin("com.github.sbt" % "sbt-github-actions" % "0.22.0")
addSbtPlugin("com.github.sbt" % "sbt-ci-release" % "1.5.12")
Loading