Skip to main content
Version: 2.5.0

DevOopsGitHubReleasePlugin - Config and Run

devOopsLogLevel#

To set the log level for GitHub release tasks (default: info). If it's debug, the log may contain the HTTP request headers which may also contain some confidential info like auth token.

It should be one of

  • debug
  • info
  • warn
  • error

Enable DevOopsGitHubReleasePlugin#

To use DevOopsGitHubReleasePlugin, add the following line to build.sbt.

enablePlugins(DevOopsGitHubReleasePlugin)

e.g.) This is an example of the minimal settings.

ThisBuild / organization := "com.example"ThisBuild / scalaVersion := "2.13.4"ThisBuild / version := "0.1.0"ThisBuild / crossScalaVersions := Seq("2.11.12", "2.12.12", "2.13.4")
lazy val root = (project in file("."))  .enablePlugins(DevOopsGitHubReleasePlugin)  .settings(    name := "test-project",    libraryDependencies += "some" %% "lib" % "1.0.0"  )

Tag#

devOopsGitTagFrom#

The name of the branch from which it tags. So if the current branch is not the same as the devOopsGitTagFrom value, devOopsGitTag does not tag but throws an exception.

Default:

devOopsGitTagFrom := "main"

devOopsGitTagDescription (Optional)#

devOopsGitTagDescription is the setting to specify the tag description. If not set, it tags without any tag description.

Default:

devOopsGitTagDescription := None

Wihtout the description, it's equivalent to

git tag ${devOopsGitTagFrom.value}

With the description, it's equivalent to

git tag -a ${devOopsGitTagFrom.value}, -m ${devOopsGitTagDescription.value}

devOopsGitTagName#

This setting decides how to name the tag. It uses the project's version (i.e. version.value) with the suffix 'v'

e.g.) If version := "1.0.0", the tag name is v1.0.0.

Default:

import just.semver.SemVer// ...devOopsGitTagName := s"v${SemVer.render(SemVer.parseUnsafe(version.value))}"

devOopsGitTagPushRepo#

This tells which remote repository to push. It's usually origin. If there are multiple repositories, you can change it to the one you want.

e.g.)

devOopsGitTagPushRepo := "github"

Default:

devOopsGitTagPushRepo := "origin"

devOopsGitTag#

It is an sbt task to create a git tag from the branch set in devOopsGitTagFrom. It may fail if the project version is no GA.

e.g.)

Success Case

sbt:test-project> devOopsGitTagtask success>>> non sbt task success> The semantic version from the project version has been parsed. version: 0.1.0>> git rev-parse --abbrev-ref HEAD => master>> git fetch --tags>> git tag v0.1.0>> git push origin v0.1.0  |  To github.com:Kevin-Lee/test-project.git  |   * [new tag]         v0.1.0 -> v0.1.0
[success] Total time: 7 s, completed 16 Oct. 2019, 5:19:31 pm

Failure Case

sbt:test-project> devOopsGitTagFailure]>> sbt task failed after finishing the following taskstask success>>> non sbt task success> The semantic version from the project version has been parsed. version: 0.1.0-SNAPSHOT
  This version is not eligible for tagging. [version: 0.1.0-SNAPSHOT]  It should be GA version with any pre-release or meta-info suffix    e.g.)    * 1.0.0 (โญ•๏ธ)    * 1.0.0-SNAPSHOT (โŒ)    * 1.0.0-beta (โŒ)    * 1.0.0+123 (โŒ)    * 1.0.0-beta+123 (โŒ)

or

sbt:test-project> devOopsGitTagFailure]>> sbt task failed after finishing the following taskstask success>>> non sbt task success> The semantic version from the project version has been parsed. version: 0.1.0>> git rev-parse --abbrev-ref HEAD => master>> git fetch --tags  | => root / gitTag 2s>> [cmd: git tag v0.1.0], [code: 128], [errors: fatal: tag 'v0.1.0' already exists]

Artifacts#

devOopsCiDir#

devOopsCiDir is the ci directory which contains the files created in build to upload to GitHub release (e.g. packaged jar files) It can be either an absolute or relative path. When running devOopsCopyReleasePackages, all the jar files with prefixed with the project name (devOopsPackagedArtifacts.value) are copied to ${devOopsCiDir.value}/dist.

Default:

devOopsCiDir := "ci"// so the artifactsare copied to ci/dist

devOopsPackagedArtifacts#

A List of packaged artifacts to be copied to PROJECT_HOME/${devOopsCiDir.value}/dist.

Default:

devOopsPackagedArtifacts := List(s"target/scala-*/${name.value}*.jar")

So for Java projects, change it to

devOopsPackagedArtifacts := List(s"target/${name.value}*.jar")

devOopsCopyReleasePackages#

It is an sbt task to copy packaged artifacts to the location specified (default: devOopsPackagedArtifacts.value to PROJECT_HOME/${devOopsCiDir.value}/dist).

e.g.)

sbt:test-project> devOopsCopyReleasePackages>> copyPackages - Files copied from:  - /user/home/test-project/target/scala-2.12/test-project_2.12-0.1.0.jar  - /user/home/test-project/target/scala-2.12/test-project_2.12-0.1.0-sources.jar  - /user/home/test-project/target/scala-2.12/test-project_2.12-0.1.0-javadoc.jar
  to  - ci/dist/test-project_2.12-0.1.0-javadoc.jar  - ci/dist/test-project_2.12-0.1.0-sources.jar  - ci/dist/test-project_2.12-0.1.0.jar

[success] Total time: 0 s, completed 6 Apr. 2019, 11:32:21 pm

Changelog#

devOopsChangelogLocation#

The location of changelog file. The change log filename should be the project version with the extension of .md.

e.g.) version.value := "1.0.0" then the changelog file should be 1.0.0.md at the location set in devOopsChangelogLocation.

Default:

changelogLocation := "changelogs"

GitHub Release#

devOopsGitHubAuthTokenEnvVar#

The name of environment variable to get the GitHub auth token. It is required to do GitHub release. If the envvar is not found, it will try to read the auth token file set in devOopsGitHubAuthTokenFile.

Default:

devOopsGitHubAuthTokenEnvVar := "GITHUB_TOKEN"

devOopsGitHubAuthTokenFile#

The path to GitHub OAuth token file. The file should contain oauth=OAUTH_TOKEN (default: Some($USER/.github)) If you want to have a different filename in user's home, do Some(new File(Io.getUserHome, "your_filename")).

Default:

devOopsGitHubAuthTokenFile := Some(new File(Io.getUserHome, ".github"))

NOTE: This is optional and if there's a value for the environment variable set in devOopsGitHubAuthTokenEnvVar, The envvar will be used instead of using the value from the auth token file. It will not even try to read the file if the envvar is set.

devOopsGitHubRequestTimeout#

Timeout for the GitHub release tasks. If it exceeds, the task may fail. (Default: 2 minutes)

devOopsGitHubRelease#

It is an sbt task to release the current version by uploading the changelog to GitHub. It does

  • Copy packaged files (devOopsCopyReleasePackages)
  • Upload the changelog to GitHub release, but it does not upload any packaged artifacts.

NOTE: It does not create any tag and if the tag with the project version (e.g. version: 1.0.0 => tag: v1.0.0) does not exist, devOopsGitHubRelease fails To also upload the packaged artifacts please have a look at devOopsGitHubReleaseUploadArtifacts.

e.g.) devOopsGitHubRelease

sbt:test-project> devOopsGitHubReleasetask success>>> git fetch --tags>> git tag  |  v0.1.0  |  v0.1.1>> task success>>> Get GitHub OAuth token
>> task success>>> Get changelog
>> task success>>> git remote get-url origin => git@github.com:Kevin-Lee/test-project.git
>> task success>>> Get GitHub repo org and name: Kevin-Lee/test-project
>> task success>>> GitHub release: v0.1.1
>> task success>>> Changelog uploaded:    # 0.1.0 - 2021-01-31
    Another Test Release
[success] Total time: 4 s, completed 17 Feb. 2021, 7:06:11 pm

e.g.) When there's no tag with the current version.

sbt:test-project> devOopsGitHubRelease[error] Failure][error] >> sbt task failed after finishing the following tasks[error] task success>[error] >> git fetch --tags[error] >> git tag[error]   v0.1.0[error]   v0.1.1[error] >> task success>[error] >> Get GitHub OAuth token[error][error] >> task success>[error] >> Get changelog[error][error] >> task success>[error] >> git remote get-url origin => git@github.com:Kevin-Lee/test-project.git[error][error] >> task success>[error] >> Get GitHub repo org and name: Kevin-Lee/test-project[error][error][error] ---[error] >> Failed:[error] Unprocessable Entity:[error] responseBody: {[error]   "message" : "Validation Failed",[error]   "documentation_url" : "https://docs.github.com/rest/reference/repos#create-a-release"[error] }

devOopsGitTagAndGitHubRelease#

Is it an sbt task to release the current version by uploading the changelog to GitHub after git tagging. It does

  • Git tag with the current version (devOopsGitTag)
  • Upload the changelog to GitHub, but it does not upload any packaged artifacts.

e.g.) devOopsGitTagAndGitHubRelease

sbt:test-project> devOopsGitTagAndGitHubReleasetask success>>> task success>>> Get GitHub OAuth token
>> non sbt task success> The semantic version from the project version has been parsed. version: 0.1.1>> git rev-parse --abbrev-ref HEAD => some-branch>> git fetch --tags>> git tag v0.1.1>> git push origin v0.1.1  |  To github.com:Kevin-Lee/test-project.git  |   * [new tag]         v0.1.1 -> v0.1.1>> task success>>> Get changelog
>> task success>>> git remote get-url origin => git@github.com:Kevin-Lee/test-project.git
>> task success>>> Get GitHub repo org and name: Kevin-Lee/test-project
>> task success>>> GitHub release: v0.1.1
>> task success>>> Changelog uploaded:    # 0.1.0 - 2021-01-31
    Another Test Release
[success] Total time: 10 s, completed 17 Feb. 2021, 7:16:59 pm

devOopsGitHubReleaseUploadArtifacts#

This is an sbt task to upload packaged artifacts to the existing GitHub release. It can fail if the release for the tag named with the current project version does not exist.

e.g.) You probably want to package the artifacts.

sbt:test-project> packagedArtifacts[info] Wrote /Users/some.user/test-project/target/scala-2.13/test-project_2.13-0.1.1.pom[info] Main Scala API documentation to /Users/some.user/test-project/target/scala-2.13/api...[warn] multiple main classes detected: run 'show discoveredMainClasses' to see the list[info] Main Scala API documentation successful.[success] Total time: 3 s, completed 17 Feb. 2021, 7:20:58 pm

Now let's upload the artifacts to GitHub release.

sbt:test-project> devOopsGitHubReleaseUploadArtifacts>> copyPackages - Files copied from:  - /Users/some.user/test-project/target/scala-2.13/test-project_2.13-0.1.1-javadoc.jar  - /Users/some.user/test-project/target/scala-2.13/test-project_2.13-0.1.1-sources.jar  - /Users/some.user/test-project/target/scala-2.13/test-project_2.13-0.1.1.jar
  to  - ci/dist/test-project_2.13-0.1.1-javadoc.jar  - ci/dist/test-project_2.13-0.1.1-sources.jar  - ci/dist/test-project_2.13-0.1.1.jar
task success>>> git fetch --tags>> git tag  |  v0.1.0  |  v0.1.1>> task success>>> Get GitHub OAuth token
>> task success>>> git remote get-url origin => git@github.com:Kevin-Lee/test-project.git
>> task success>>> Get GitHub repo org and name: Kevin-Lee/test-project
>> task success>>> try to find a GitHub release with the given tag: v0.1.1
>> task success>>> GitHub release: v0.1.1
>> task success>>> Files uploaded:    - test-project_2.13-0.1.1-javadoc.jar @ https://github.com/Kevin-Lee/test-project/releases/download/v0.1.1/test-project_2.13-0.1.1-javadoc.jar    - test-project_2.13-0.1.1-sources.jar @ https://github.com/Kevin-Lee/test-project/releases/download/v0.1.1/test-project_2.13-0.1.1-sources.jar    - test-project_2.13-0.1.1.jar @ https://github.com/Kevin-Lee/test-project/releases/download/v0.1.1/test-project_2.13-0.1.1.jar
[success] Total time: 16 s, completed 17 Feb. 2021, 7:21:18 pm