├── project ├── build.properties └── plugins.sbt ├── repository.yaml ├── .gitignore ├── src ├── main │ └── scala │ │ └── uk │ │ └── gov │ │ └── hmrc │ │ └── gitstamp │ │ ├── GitStampPlugin.scala │ │ └── GitStamp.scala └── test │ └── scala │ └── uk │ └── gov │ └── hmrc │ └── gitstamp │ └── GitStampSpec.scala ├── README.md └── LICENSE /project/build.properties: -------------------------------------------------------------------------------- 1 | sbt.version=1.9.9 2 | -------------------------------------------------------------------------------- /repository.yaml: -------------------------------------------------------------------------------- 1 | repoVisibility: public_0C3F0CE3E6E6448FAD341E7BFA50FCD333E06A20CFF05FCACE61154DDBBADF71 2 | description: SBT Plugin that add's git meta data to MANIFEST.MF 3 | -------------------------------------------------------------------------------- /project/plugins.sbt: -------------------------------------------------------------------------------- 1 | 2 | resolvers += MavenRepository("HMRC-open-artefacts-maven2", "https://open.artefacts.tax.service.gov.uk/maven2") 3 | resolvers += Resolver.url("HMRC-open-artefacts-ivy2", url("https://open.artefacts.tax.service.gov.uk/ivy2"))(Resolver.ivyStylePatterns) 4 | 5 | addSbtPlugin("uk.gov.hmrc" % "sbt-auto-build" % "3.22.0") 6 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | *.class 2 | target 3 | logs 4 | pids 5 | .gitconfig 6 | 7 | */*dependency-reduced-pom.xml 8 | 9 | *.war 10 | *.ear 11 | 12 | *.ipr 13 | *.iws 14 | *.iml 15 | **/*.iml 16 | .idea 17 | *.swp 18 | 19 | .DS_Store 20 | **/*.DS_Store 21 | 22 | **/target/* 23 | target 24 | 25 | lib_managed/* 26 | **/lib_managed/* 27 | **/bin/* 28 | *.classpath 29 | *.project 30 | **/*.settings 31 | .project 32 | .settings 33 | .classpath 34 | .sass-cache 35 | 36 | .ensime* 37 | 38 | **/codekit-config.json 39 | nohup.out 40 | .metals/ 41 | .vscode/ 42 | -------------------------------------------------------------------------------- /src/main/scala/uk/gov/hmrc/gitstamp/GitStampPlugin.scala: -------------------------------------------------------------------------------- 1 | /* 2 | * Copyright 2019 HM Revenue & Customs 3 | * 4 | * Licensed under the Apache License, Version 2.0 (the "License"); 5 | * you may not use this file except in compliance with the License. 6 | * You may obtain a copy of the License at 7 | * 8 | * http://www.apache.org/licenses/LICENSE-2.0 9 | * 10 | * Unless required by applicable law or agreed to in writing, software 11 | * distributed under the License is distributed on an "AS IS" BASIS, 12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13 | * See the License for the specific language governing permissions and 14 | * limitations under the License. 15 | */ 16 | 17 | package uk.gov.hmrc.gitstamp 18 | 19 | import sbt.Keys._ 20 | import sbt.Package.ManifestAttributes 21 | import sbt._ 22 | 23 | object GitStampPlugin extends AutoPlugin { 24 | 25 | val gitStampSettings: Seq[Def.Setting[Task[scala.Seq[PackageOption]]]] = 26 | Seq(packageOptions += ManifestAttributes(GitStamp.gitStamp.toSeq: _*)) 27 | 28 | } -------------------------------------------------------------------------------- /src/test/scala/uk/gov/hmrc/gitstamp/GitStampSpec.scala: -------------------------------------------------------------------------------- 1 | /* 2 | * Copyright 2019 HM Revenue & Customs 3 | * 4 | * Licensed under the Apache License, Version 2.0 (the "License"); 5 | * you may not use this file except in compliance with the License. 6 | * You may obtain a copy of the License at 7 | * 8 | * http://www.apache.org/licenses/LICENSE-2.0 9 | * 10 | * Unless required by applicable law or agreed to in writing, software 11 | * distributed under the License is distributed on an "AS IS" BASIS, 12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13 | * See the License for the specific language governing permissions and 14 | * limitations under the License. 15 | */ 16 | 17 | package uk.gov.hmrc.gitstamp 18 | 19 | import org.scalatest.matchers.should.Matchers 20 | import org.scalatest.wordspec.AnyWordSpec 21 | 22 | class GitStampSpec extends AnyWordSpec with Matchers { 23 | 24 | "Git repo information" in { 25 | val info = GitStamp.gitStamp 26 | info should contain key "Build-Date" 27 | info should contain key "Git-Branch" 28 | info should contain key "Git-Repo-Is-Clean" 29 | info should contain key "Git-Head-Rev" 30 | info should contain key "Git-Commit-Author" 31 | info should contain key "Git-Commit-Date" 32 | info should contain key "Git-Describe" 33 | } 34 | } 35 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | sbt-git-stamp 2 | ============= 3 | 4 | 5 | 6 | An SBT plugin that add some basic git data to the artefact's `MANIFEST.MF` file. 7 | 8 | We cannot take the credit for the idea of this plugin as the source is a fork from Patrick Kaeding's [creation](https://bitbucket.org/pkaeding/sbt-git-stamp) 9 | 10 | ## What it does ## 11 | 12 | A plugin including some basic information about the state of the repository that the artifact was built from, 13 | at the time it was built. This information includes: 14 | 15 | * Head revision 16 | * Branch name 17 | * Whether or not there were uncommitted changes 18 | * Build date 19 | 20 | This information is included in the `MANIFEST.MF` file in the jar produced by the `package` (or `assembly`) tasks. This can 21 | help you track down where a build came from. 22 | 23 | ## How to use it ## 24 | 25 | ### Sbt 1.x 26 | 27 | Since major version 6, this plugin is cross compiled for sbt 1.x (specifically 1.3.4). 28 | 29 | | Sbt version | Plugin version | 30 | | ----------- | -------------- | 31 | | `0.13.x` | `any` | 32 | | `>= 1.x` | `>= 6.x` | 33 | 34 | Add the following to your `project/plugins.sbt`: 35 | 36 | ```scala 37 | resolvers += Resolver.url("hmrc-sbt-plugin-releases", 38 | url("https://dl.bintray.com/hmrc/sbt-plugin-releases"))(Resolver.ivyStylePatterns) 39 | 40 | addSbtPlugin("uk.gov.hmrc" % "sbt-git-stamp" % "INSERT_VERSION") 41 | ``` 42 | 43 | Add the following near the top of your `build.sbt` file: 44 | 45 | ```scala 46 | import uk.gov.hmrc.gitstamp.GitStampPlugin._ 47 | ``` 48 | 49 | Then, add this lower down: 50 | 51 | ```scala 52 | Seq(gitStampSettings: _*) 53 | ``` 54 | 55 | Then, just build as normal. This plugin won't add any tasks, or otherwise change the way you interact with SBT. 56 | 57 | Your artifacts will just come out with a `MANIFEST.MF` file that looks something like this: 58 | 59 | ``` 60 | Manifest-Version: 1.0 61 | Implementation-Vendor: My-Company 62 | Implementation-Title: My Project 63 | Implementation-Version: 0.1 64 | Implementation-Vendor-Id: My-Company 65 | Specification-Vendor: My-Company 66 | Git-Repo-Is-Clean: false 67 | Git-Branch: gitstamp 68 | Specification-Title: My Company 69 | Git-Build-Date: 2013-04-26T17:22:58.538-07:00 70 | Specification-Version: 0.1 71 | Git-Head-Rev: b0d5a67d59dc7c0133aecce2e2ceb18fc8d23597 72 | Git-Describe: release/0.3.5-b0d5a67 73 | ``` 74 | 75 | The entries starting with `Git-` were added by this plugin. 76 | 77 | ## License ## 78 | 79 | This code is open source software licensed under the [Apache 2.0 License]("http://www.apache.org/licenses/LICENSE-2.0.html"). 80 | -------------------------------------------------------------------------------- /src/main/scala/uk/gov/hmrc/gitstamp/GitStamp.scala: -------------------------------------------------------------------------------- 1 | /* 2 | * Copyright 2019 HM Revenue & Customs 3 | * 4 | * Licensed under the Apache License, Version 2.0 (the "License"); 5 | * you may not use this file except in compliance with the License. 6 | * You may obtain a copy of the License at 7 | * 8 | * http://www.apache.org/licenses/LICENSE-2.0 9 | * 10 | * Unless required by applicable law or agreed to in writing, software 11 | * distributed under the License is distributed on an "AS IS" BASIS, 12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13 | * See the License for the specific language governing permissions and 14 | * limitations under the License. 15 | */ 16 | 17 | package uk.gov.hmrc.gitstamp 18 | 19 | import org.eclipse.jgit.api.Git 20 | import org.eclipse.jgit.lib.Constants._ 21 | import org.eclipse.jgit.lib.{ObjectId, Repository} 22 | import org.eclipse.jgit.revwalk.RevCommit 23 | import org.eclipse.jgit.storage.file.FileRepositoryBuilder 24 | 25 | import java.time.{Instant, ZoneId} 26 | import java.time.format.DateTimeFormatter 27 | import scala.jdk.CollectionConverters._ 28 | 29 | object GitStamp { 30 | 31 | private val formatter = 32 | DateTimeFormatter.ofPattern("yyyy-MM-dd'T'HH:mm:ss.SSSZ").withZone(ZoneId.systemDefault) 33 | 34 | def gitStamp: Map[String, String] = 35 | gitStamp(new FileRepositoryBuilder().readEnvironment.findGitDir.build) 36 | 37 | def gitStamp(repository: Repository): Map[String, String] = { 38 | val git = new Git(repository) 39 | val headId = repository.exactRef(HEAD).getObjectId 40 | val headIdStr = ObjectId.toString(headId) 41 | val describe = Option(git.describe().call()).getOrElse(headIdStr) 42 | val headRev = headCommit(git, headId) 43 | 44 | Map( 45 | "Build-Date" -> formatter.format(Instant.now()), 46 | "Git-Branch" -> repository.getBranch, 47 | "Git-Repo-Is-Clean" -> repoIsClean(git), 48 | "Git-Head-Rev" -> headIdStr, 49 | "Git-Commit-Author" -> commitAuthorName(headRev), 50 | "Git-Commit-Date" -> commitDateTime(headRev), 51 | "Git-Describe" -> describe 52 | ) 53 | } 54 | 55 | private def repoIsClean(git: Git): String = 56 | git.status.call.isClean.toString 57 | 58 | private def commitDateTime(headRev: Option[RevCommit]): String = 59 | formatter.format(Instant.ofEpochSecond(headRev.fold(0L)(_.getCommitTime.toLong))) 60 | 61 | private def commitAuthorName(headRev: Option[RevCommit]): String = 62 | headRev.map(_.getCommitterIdent.getName).getOrElse("") 63 | 64 | private def headCommit(git: Git, headId: ObjectId): Option[RevCommit] = 65 | git.log().add(headId).setMaxCount(1).call().asScala.toSeq.headOption 66 | } 67 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | Apache License 2 | Version 2.0, January 2004 3 | http://www.apache.org/licenses/ 4 | 5 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 6 | 7 | 1. Definitions. 8 | 9 | "License" shall mean the terms and conditions for use, reproduction, 10 | and distribution as defined by Sections 1 through 9 of this document. 11 | 12 | "Licensor" shall mean the copyright owner or entity authorized by 13 | the copyright owner that is granting the License. 14 | 15 | "Legal Entity" shall mean the union of the acting entity and all 16 | other entities that control, are controlled by, or are under common 17 | control with that entity. For the purposes of this definition, 18 | "control" means (i) the power, direct or indirect, to cause the 19 | direction or management of such entity, whether by contract or 20 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 21 | outstanding shares, or (iii) beneficial ownership of such entity. 22 | 23 | "You" (or "Your") shall mean an individual or Legal Entity 24 | exercising permissions granted by this License. 25 | 26 | "Source" form shall mean the preferred form for making modifications, 27 | including but not limited to software source code, documentation 28 | source, and configuration files. 29 | 30 | "Object" form shall mean any form resulting from mechanical 31 | transformation or translation of a Source form, including but 32 | not limited to compiled object code, generated documentation, 33 | and conversions to other media types. 34 | 35 | "Work" shall mean the work of authorship, whether in Source or 36 | Object form, made available under the License, as indicated by a 37 | copyright notice that is included in or attached to the work 38 | (an example is provided in the Appendix below). 39 | 40 | "Derivative Works" shall mean any work, whether in Source or Object 41 | form, that is based on (or derived from) the Work and for which the 42 | editorial revisions, annotations, elaborations, or other modifications 43 | represent, as a whole, an original work of authorship. For the purposes 44 | of this License, Derivative Works shall not include works that remain 45 | separable from, or merely link (or bind by name) to the interfaces of, 46 | the Work and Derivative Works thereof. 47 | 48 | "Contribution" shall mean any work of authorship, including 49 | the original version of the Work and any modifications or additions 50 | to that Work or Derivative Works thereof, that is intentionally 51 | submitted to Licensor for inclusion in the Work by the copyright owner 52 | or by an individual or Legal Entity authorized to submit on behalf of 53 | the copyright owner. For the purposes of this definition, "submitted" 54 | means any form of electronic, verbal, or written communication sent 55 | to the Licensor or its representatives, including but not limited to 56 | communication on electronic mailing lists, source code control systems, 57 | and issue tracking systems that are managed by, or on behalf of, the 58 | Licensor for the purpose of discussing and improving the Work, but 59 | excluding communication that is conspicuously marked or otherwise 60 | designated in writing by the copyright owner as "Not a Contribution." 61 | 62 | "Contributor" shall mean Licensor and any individual or Legal Entity 63 | on behalf of whom a Contribution has been received by Licensor and 64 | subsequently incorporated within the Work. 65 | 66 | 2. Grant of Copyright License. Subject to the terms and conditions of 67 | this License, each Contributor hereby grants to You a perpetual, 68 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 69 | copyright license to reproduce, prepare Derivative Works of, 70 | publicly display, publicly perform, sublicense, and distribute the 71 | Work and such Derivative Works in Source or Object form. 72 | 73 | 3. Grant of Patent License. Subject to the terms and conditions of 74 | this License, each Contributor hereby grants to You a perpetual, 75 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 76 | (except as stated in this section) patent license to make, have made, 77 | use, offer to sell, sell, import, and otherwise transfer the Work, 78 | where such license applies only to those patent claims licensable 79 | by such Contributor that are necessarily infringed by their 80 | Contribution(s) alone or by combination of their Contribution(s) 81 | with the Work to which such Contribution(s) was submitted. If You 82 | institute patent litigation against any entity (including a 83 | cross-claim or counterclaim in a lawsuit) alleging that the Work 84 | or a Contribution incorporated within the Work constitutes direct 85 | or contributory patent infringement, then any patent licenses 86 | granted to You under this License for that Work shall terminate 87 | as of the date such litigation is filed. 88 | 89 | 4. Redistribution. You may reproduce and distribute copies of the 90 | Work or Derivative Works thereof in any medium, with or without 91 | modifications, and in Source or Object form, provided that You 92 | meet the following conditions: 93 | 94 | (a) You must give any other recipients of the Work or 95 | Derivative Works a copy of this License; and 96 | 97 | (b) You must cause any modified files to carry prominent notices 98 | stating that You changed the files; and 99 | 100 | (c) You must retain, in the Source form of any Derivative Works 101 | that You distribute, all copyright, patent, trademark, and 102 | attribution notices from the Source form of the Work, 103 | excluding those notices that do not pertain to any part of 104 | the Derivative Works; and 105 | 106 | (d) If the Work includes a "NOTICE" text file as part of its 107 | distribution, then any Derivative Works that You distribute must 108 | include a readable copy of the attribution notices contained 109 | within such NOTICE file, excluding those notices that do not 110 | pertain to any part of the Derivative Works, in at least one 111 | of the following places: within a NOTICE text file distributed 112 | as part of the Derivative Works; within the Source form or 113 | documentation, if provided along with the Derivative Works; or, 114 | within a display generated by the Derivative Works, if and 115 | wherever such third-party notices normally appear. The contents 116 | of the NOTICE file are for informational purposes only and 117 | do not modify the License. You may add Your own attribution 118 | notices within Derivative Works that You distribute, alongside 119 | or as an addendum to the NOTICE text from the Work, provided 120 | that such additional attribution notices cannot be construed 121 | as modifying the License. 122 | 123 | You may add Your own copyright statement to Your modifications and 124 | may provide additional or different license terms and conditions 125 | for use, reproduction, or distribution of Your modifications, or 126 | for any such Derivative Works as a whole, provided Your use, 127 | reproduction, and distribution of the Work otherwise complies with 128 | the conditions stated in this License. 129 | 130 | 5. Submission of Contributions. Unless You explicitly state otherwise, 131 | any Contribution intentionally submitted for inclusion in the Work 132 | by You to the Licensor shall be under the terms and conditions of 133 | this License, without any additional terms or conditions. 134 | Notwithstanding the above, nothing herein shall supersede or modify 135 | the terms of any separate license agreement you may have executed 136 | with Licensor regarding such Contributions. 137 | 138 | 6. Trademarks. This License does not grant permission to use the trade 139 | names, trademarks, service marks, or product names of the Licensor, 140 | except as required for reasonable and customary use in describing the 141 | origin of the Work and reproducing the content of the NOTICE file. 142 | 143 | 7. Disclaimer of Warranty. Unless required by applicable law or 144 | agreed to in writing, Licensor provides the Work (and each 145 | Contributor provides its Contributions) on an "AS IS" BASIS, 146 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 147 | implied, including, without limitation, any warranties or conditions 148 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 149 | PARTICULAR PURPOSE. You are solely responsible for determining the 150 | appropriateness of using or redistributing the Work and assume any 151 | risks associated with Your exercise of permissions under this License. 152 | 153 | 8. Limitation of Liability. In no event and under no legal theory, 154 | whether in tort (including negligence), contract, or otherwise, 155 | unless required by applicable law (such as deliberate and grossly 156 | negligent acts) or agreed to in writing, shall any Contributor be 157 | liable to You for damages, including any direct, indirect, special, 158 | incidental, or consequential damages of any character arising as a 159 | result of this License or out of the use or inability to use the 160 | Work (including but not limited to damages for loss of goodwill, 161 | work stoppage, computer failure or malfunction, or any and all 162 | other commercial damages or losses), even if such Contributor 163 | has been advised of the possibility of such damages. 164 | 165 | 9. Accepting Warranty or Additional Liability. While redistributing 166 | the Work or Derivative Works thereof, You may choose to offer, 167 | and charge a fee for, acceptance of support, warranty, indemnity, 168 | or other liability obligations and/or rights consistent with this 169 | License. However, in accepting such obligations, You may act only 170 | on Your own behalf and on Your sole responsibility, not on behalf 171 | of any other Contributor, and only if You agree to indemnify, 172 | defend, and hold each Contributor harmless for any liability 173 | incurred by, or claims asserted against, such Contributor by reason 174 | of your accepting any such warranty or additional liability. 175 | 176 | END OF TERMS AND CONDITIONS 177 | 178 | APPENDIX: How to apply the Apache License to your work. 179 | 180 | To apply the Apache License to your work, attach the following 181 | boilerplate notice, with the fields enclosed by brackets "[]" 182 | replaced with your own identifying information. (Don't include 183 | the brackets!) The text should be enclosed in the appropriate 184 | comment syntax for the file format. We also recommend that a 185 | file or class name and description of purpose be included on the 186 | same "printed page" as the copyright notice for easier 187 | identification within third-party archives. 188 | 189 | Copyright [yyyy] [name of copyright owner] 190 | 191 | Licensed under the Apache License, Version 2.0 (the "License"); 192 | you may not use this file except in compliance with the License. 193 | You may obtain a copy of the License at 194 | 195 | http://www.apache.org/licenses/LICENSE-2.0 196 | 197 | Unless required by applicable law or agreed to in writing, software 198 | distributed under the License is distributed on an "AS IS" BASIS, 199 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 200 | See the License for the specific language governing permissions and 201 | limitations under the License. 202 | --------------------------------------------------------------------------------