https://github.com/pjfanning/sbt-source-dist
An sbt plugin source distributions for Apache Pekko
https://github.com/pjfanning/sbt-source-dist
pekko sbt-plugin
Last synced: 24 days ago
JSON representation
An sbt plugin source distributions for Apache Pekko
- Host: GitHub
- URL: https://github.com/pjfanning/sbt-source-dist
- Owner: pjfanning
- License: apache-2.0
- Created: 2023-01-30T19:52:12.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-10-17T22:04:40.000Z (7 months ago)
- Last Synced: 2025-03-25T01:51:15.504Z (about 1 month ago)
- Topics: pekko, sbt-plugin
- Language: Scala
- Homepage:
- Size: 127 KB
- Stars: 2
- Watchers: 3
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# sbt-source-dist
An sbt plugin to produce source distributions for
[Apache Pekko](https://github.com/apache/pekko).
* Outputs to target/dist directory of the root project
## sbt plugin
sbt-source-dist is designed as an [AutoPlugin](https://www.scala-sbt.org/1.x/docs/Plugins.html) that immediately
triggers onto the root project. If necessary one can override one of
projects [keys](/src/main/scala/com/github/pjfanning/sourcedist/SourceDistKeys.scala), i.e. if the name of your project
doesn't your Apache projects name you can do
```sbt
sourceDistName := "My Apache Project"
```
If you have an explicit root project then you can do the following
```sbt
val root = Project(id = "root", base = file(".")).settings(
sourceDistName := "My Apache Project"
)
```
You can then generate the source distribution using
```
sbt sourceDistGenerate
```
sbt-source-dist also supports signing the final generated source distribution
using [sbt-pgp](https://github.com/sbt/sbt-pgp). Signing the source
distribution in this manner has the added advantage of ensuring that the same
signing key that is used to sign binary maven artifacts is also used for the
source dist.
You can both generate the source distribution and then sign it using
```
sbt signedSourceDistGenerate
```
`signedSourceDistGenerate` will re-use the same settings provided by sbt-pgp
so if you need to configure it follow the instructions at https://github.com/sbt/sbt-pgp#usage.