Publish to GH Packages from Sbt without plugins
Use a zero cost Maven repository to publish my hobby project packages and do that from Scala/sbt without needing additional plugins.
Note
These are not step by step instructions, they are a summary of the notes I took when setting up my environment. To follow them, you should be familiar with your OS (mine is MacOS), Python, Pip, Mkdocs and Github Actions
The Quick Solution¶
Create a Repository in Github¶
This repository will be the host for the maven registry.
It can be under your user or an organization that you have enough permissions.
Create a Personal Access Token¶
With read and write access to the repository you just created.
Configure that access token in an environment variable of the system that will run sbt. This is in your local machine or a a Secret in a Git Hub action that feeds an environment variable.
Put everything together in build.sbt¶
You will need:
- Your github user name:
<user> - The name of the Token Environment variable:
<TOKEN_VAR> - The name of the repository:
- User or organization:
<org> - Repo Name:
<repo>
- User or organization:
Note that the values of ghRepoName and repoHost below should NOT be changed.
enablePlugins (
JavaAppPackaging
)
val user = <user>
val repo = <repo>
val org = <org>
val tk_var = <TOKEN_VAR>
val ghRepoName = "GitHub Package Registry"
val repoHost = "maven.pkg.github.com"
sys.env.get(tk_var).map{
ghTk => Credentials(ghRepoName, repoHost, user, ghTk)
}.match {
case None => Nil
case Some(cred) => credentials += cred
}
val packagesRepo = s"https://$repoHost/$user/$repo"
publishTo := { Some(new DependencyBuilders{}).toRepositoryName(ghRepoName).at(packagesRepo) }