├── .github ├── CODEOWNERS ├── dependabot.yml └── workflows │ └── build.yml ├── project ├── build.properties └── plugin.sbt ├── src └── main │ ├── scala-2 │ └── io │ │ └── github │ │ └── gitbucket │ │ └── sbt │ │ └── GitBucketPluginCompat.scala │ ├── scala-3 │ └── io │ │ └── github │ │ └── gitbucket │ │ └── sbt │ │ └── GitBucketPluginCompat.scala │ └── scala │ └── io │ └── github │ └── gitbucket │ └── sbt │ ├── GitBucketPluginKeys.scala │ ├── GitBucketPlugin.scala │ └── GitBucketPluginTasks.scala ├── .gitignore ├── README.md └── LICENSE /.github/CODEOWNERS: -------------------------------------------------------------------------------- 1 | * @takezoe @xuwei-k 2 | -------------------------------------------------------------------------------- /project/build.properties: -------------------------------------------------------------------------------- 1 | sbt.version=1.11.7 2 | -------------------------------------------------------------------------------- /project/plugin.sbt: -------------------------------------------------------------------------------- 1 | libraryDependencies += { "org.scala-sbt" %% "scripted-plugin" % sbtVersion.value } 2 | addSbtPlugin("com.github.sbt" % "sbt-pgp" % "2.3.1") 3 | -------------------------------------------------------------------------------- /.github/dependabot.yml: -------------------------------------------------------------------------------- 1 | version: 2 2 | updates: 3 | - package-ecosystem: "github-actions" 4 | directory: "/" 5 | schedule: 6 | interval: "weekly" 7 | -------------------------------------------------------------------------------- /src/main/scala-2/io/github/gitbucket/sbt/GitBucketPluginCompat.scala: -------------------------------------------------------------------------------- 1 | package io.github.gitbucket.sbt 2 | 3 | import java.io.File 4 | 5 | private[sbt] object GitBucketPluginCompat { 6 | def toFile(f: File): File = f 7 | } 8 | -------------------------------------------------------------------------------- /src/main/scala-3/io/github/gitbucket/sbt/GitBucketPluginCompat.scala: -------------------------------------------------------------------------------- 1 | package io.github.gitbucket.sbt 2 | 3 | import java.io.File 4 | 5 | private[sbt] object GitBucketPluginCompat { 6 | inline def toFile(f: xsbti.HashedVirtualFileRef): File = 7 | sbt.Keys.fileConverter.value.toPath(f).toFile 8 | } 9 | -------------------------------------------------------------------------------- /src/main/scala/io/github/gitbucket/sbt/GitBucketPluginKeys.scala: -------------------------------------------------------------------------------- 1 | package io.github.gitbucket.sbt 2 | 3 | import sbt._ 4 | 5 | trait GitBucketPluginKeys { 6 | lazy val gitbucketVersion = settingKey[String]("GitBucket version") 7 | @transient 8 | lazy val install = taskKey[Unit]("Install the plugin to a local GitBucket instance.") 9 | } 10 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | *.class 2 | *.log 3 | 4 | # sbt specific 5 | dist/* 6 | target/ 7 | lib_managed/ 8 | src_managed/ 9 | project/boot/ 10 | project/plugins/project/ 11 | .bsp/ 12 | 13 | # Scala-IDE specific 14 | .scala_dependencies 15 | .classpath 16 | .project 17 | .cache 18 | .settings 19 | 20 | # IntelliJ specific 21 | .idea/ 22 | .idea_modules/ 23 | 24 | # Ensime 25 | .ensime 26 | .ensime_cache/ 27 | 28 | # Metals 29 | .vscode 30 | .metals 31 | .bloop 32 | **/metals.sbt 33 | -------------------------------------------------------------------------------- /.github/workflows/build.yml: -------------------------------------------------------------------------------- 1 | name: build 2 | 3 | on: 4 | push: 5 | branches: [ master ] 6 | pull_request: 7 | branches: [ master ] 8 | 9 | jobs: 10 | build: 11 | runs-on: ubuntu-latest 12 | strategy: 13 | matrix: 14 | java: [11] 15 | steps: 16 | - uses: actions/checkout@v6 17 | - name: Set up JDK 18 | uses: actions/setup-java@v5 19 | with: 20 | distribution: temurin 21 | java-version: ${{ matrix.java }} 22 | - uses: sbt/setup-sbt@v1 23 | - name: Run tests 24 | run: sbt "+ test" 25 | -------------------------------------------------------------------------------- /src/main/scala/io/github/gitbucket/sbt/GitBucketPlugin.scala: -------------------------------------------------------------------------------- 1 | package io.github.gitbucket.sbt 2 | 3 | import sbt._ 4 | import Keys._ 5 | import play.twirl.sbt.SbtTwirl 6 | import sbtassembly.AssemblyPlugin 7 | 8 | object GitBucketPlugin extends sbt.AutoPlugin { 9 | override def requires = AssemblyPlugin /*&& SbtTwirl*/ 10 | override def trigger = allRequirements 11 | 12 | object autoImport extends GitBucketPluginKeys 13 | import autoImport._ 14 | import AssemblyPlugin.autoImport._ 15 | 16 | override lazy val projectSettings: Seq[Def.Setting[?]] = Seq( 17 | install := GitBucketPluginTasks.installTask(install).value, 18 | libraryDependencies ++= Seq( 19 | "io.github.gitbucket" %% "gitbucket" % gitbucketVersion.value % "provided", 20 | "javax.servlet" % "javax.servlet-api" % "3.1.0" % "provided" 21 | ), 22 | assembly / assemblyOption := (assembly / assemblyOption).value.withIncludeScala(false).withIncludeDependency(true), 23 | assembly / assemblyJarName := name.value + "-" + version.value + ".jar" 24 | ) ++ SbtTwirl.projectSettings.filterNot(_.key.key == libraryDependencies.key) 25 | 26 | } 27 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | sbt-gitbucket-plugin [![build](https://github.com/gitbucket/sbt-gitbucket-plugin/actions/workflows/build.yml/badge.svg?branch=master&event=push)](https://github.com/gitbucket/sbt-gitbucket-plugin/actions/workflows/build.yml) [![Maven Central](https://maven-badges.herokuapp.com/maven-central/io.github.gitbucket/sbt-gitbucket-plugin/badge.svg)](https://maven-badges.herokuapp.com/maven-central/io.github.gitbucket/sbt-gitbucket-plugin) [![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://github.com/gitbucket/gitbucket/blob/master/LICENSE) 2 | ======== 3 | 4 | This sbt plugin supports GitBucket plugin development. 5 | 6 | Add a following line to your GitBucket plugin's `project/plugin.sbt`: 7 | 8 | ```scala 9 | addSbtPlugin("io.github.gitbucket" % "sbt-gitbucket-plugin" % "1.6.0") 10 | ``` 11 | 12 | and define the target GitBucket version in `build.sbt`: 13 | 14 | ```scala 15 | gitbucketVersion := "4.39.0" 16 | ``` 17 | 18 | This plugin provides following functionality in your GitBucket plugin project: 19 | 20 | - Add GitBucket core library and Servlet API dependencies to the project as "provided" scope 21 | - Enable [sbt-assembly](https://github.com/sbt/sbt-assembly) plugin to package your GitBucket plugin 22 | - Enable [sbt-twirl](https://github.com/playframework/twirl) plugin to compile twirl templates 23 | - Enable `sbt install` task to build and install the GitBucket plugin to the local GitBucket instance 24 | -------------------------------------------------------------------------------- /src/main/scala/io/github/gitbucket/sbt/GitBucketPluginTasks.scala: -------------------------------------------------------------------------------- 1 | package io.github.gitbucket.sbt 2 | 3 | import sbt._ 4 | import Keys._ 5 | import Def.Initialize 6 | import sbtassembly.AssemblyKeys.assembly 7 | 8 | object GitBucketPluginTasks { 9 | def installTask(key: TaskKey[Unit]): Initialize[Task[Unit]] = Def.task { 10 | val file = GitBucketPluginCompat.toFile(assembly.value) 11 | 12 | val GitBucketHome = (System.getProperty("gitbucket.home") match { 13 | // -Dgitbucket.home= 14 | case path if(path != null) => new File(path) 15 | case _ => scala.util.Properties.envOrNone("GITBUCKET_HOME") match { 16 | // environment variable GITBUCKET_HOME 17 | case Some(env) => new File(env) 18 | // default is HOME/.gitbucket 19 | case None => { 20 | val oldHome = new File(System.getProperty("user.home"), "gitbucket") 21 | if(oldHome.exists && oldHome.isDirectory && new File(oldHome, "version").exists){ 22 | //FileUtils.moveDirectory(oldHome, newHome) 23 | oldHome 24 | } else { 25 | new File(System.getProperty("user.home"), ".gitbucket") 26 | } 27 | } 28 | } 29 | }) 30 | 31 | val PluginDir = new File(GitBucketHome, "plugins") 32 | if(!PluginDir.exists){ 33 | PluginDir.mkdirs() 34 | } 35 | 36 | val log = streams.value.log 37 | log.info(s"Copying ${file.getAbsolutePath} to ${PluginDir.getAbsolutePath}") 38 | 39 | IO.copyFile(file, new File(PluginDir, file.getName)) 40 | 41 | () 42 | } 43 | 44 | } 45 | -------------------------------------------------------------------------------- /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 | --------------------------------------------------------------------------------