commit aa37837e3bee246b8fcdbf19111cec47b052e57b Author: Fankesyooni <37344460+fankes@users.noreply.github.com> Date: Fri Sep 8 14:54:51 2023 +0800 Initial commit diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..496ee2c --- /dev/null +++ b/.gitignore @@ -0,0 +1 @@ +.DS_Store \ No newline at end of file diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..261eeb9 --- /dev/null +++ b/LICENSE @@ -0,0 +1,201 @@ + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright [yyyy] [name of copyright owner] + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. diff --git a/README.md b/README.md new file mode 100644 index 0000000..e91f807 --- /dev/null +++ b/README.md @@ -0,0 +1,191 @@ +# maven-repository-template + +[![GitHub license](https://img.shields.io/github/license/HighCapable/maven-repository-template?color=blue)](https://github.com/HighCapable/maven-repository-template/blob/main/LICENSE) + +This is a simple Maven repository by using GitHub to manage dependencies. + +You can fork this repository as a template to create your own personal Maven repository, provided it maintains and follows the `Apache-2.0` license. + +这是一个使用 GitHub 管理依赖的简单 Maven 存储库。 + +你可以复刻此存储库作为模版创建自己的私人 Maven 存储库，但必须保持并遵循 `Apache-2.0` 许可协议。 + +## Usage + +The directory `repository` is the repository, which contains two parts: `releases` (release version) and `snapshots` (snapshots), where all Maven project artifacts are stored. + +Reference this repository using the link below. + +> Releases + +``` +https://raw.githubusercontent.com/[organization name or username]/[repository name]/[branch name]/repository/releases +``` + +> SnapShots + +``` +https://raw.githubusercontent.com/[organization name or username]/[repository name]/[branch name]/repository/snapshots +``` + +### Usage in Gradle Projects + +You can use this repository in any Gradle project. + +#### Configure Repository + +```kotlin +repositories { + maven { + name = "personal-maven-repository-releases" + setUrl("https://raw.githubusercontent.com/[organization name or user name]/[repository name]/[branch name]/repository/releases") + } + maven { + name = "personal-maven-repository-snapshots" + setUrl("https://raw.githubusercontent.com/[organization name or username]/[repository name]/[branch name]/repository/snapshots") + } +} +``` + +You can also use [SweetDependency](https://github/HighCapable/SweetDependency) to uniformly manage and set up repositories. + +```yaml +repositories: + personal-maven-repository-releases: + url: https://raw.githubusercontent.com/[organization name or username]/[repository name]/[branch name]/repository/releases + personal-maven-repository-snapshots: + url: https://raw.githubusercontent.com/[organization name or username]/[repository name]/[branch name]/repository/snapshots +``` + +#### Publish Artifacts to Repository + +It is recommended to use vanniktech's [gradle-maven-publish-plugin](https://vanniktech.github.io/gradle-maven-publish-plugin) to publish Maven artifacts. + +Below is a reference for how to configure a repository to publish to. + +You can publish the repository directly to the `.gradle/personal-maven-repository` directory under your local user directory, and then set `personal-maven-repository` as a git repository. + +Connect the `personal-maven-repository` directory to GitHub. + +After each release of artifacts, perform a `git commit` and `git push` to synchronize the current repository. + +```kotlin +publishing { + repositories { + val repositoryDir = gradle.gradleUserHomeDir + .resolve("personal-maven-repository") + .resolve("repository") + maven { + name = "PersonalMavenReleases" + url = repositoryDir.resolve("releases").toURI() + } + maven { + name = "PersonalMavenSnapShots" + url = repositoryDir.resolve("snapshots").toURI() + } + } +} +``` + +## 使用方法 + +目录 `repository` 即为存储库，其中包含了 `releases` (发行版) 和 `snapshots` (快照) 两部分，这里存放了所有 Maven 项目的工件。 + +使用以下链接引用此存储库。 + +> Releases + +``` +https://raw.githubusercontent.com/[组织名或用户名]/[存储库名]/[分支名]/repository/releases +``` + +> SnapShots + +``` +https://raw.githubusercontent.com/[组织名或用户名]/[存储库名]/[分支名]/repository/snapshots +``` + +针对中国大陆地区无法访问 `raw.githubusercontent.com` 可以使用加速服务，例如 [GitMirror](https://gitmirror.com/)。 + +### 在 Gradle 项目中使用 + +你可以在任意 Gradle 项目中使用此存储库。 + +#### 配置存储库 + +```kotlin +repositories { + maven { + name = "personal-maven-repository-releases" + setUrl("https://raw.githubusercontent.com/[组织名或用户名]/[存储库名]/[分支名]/repository/releases") + } + maven { + name = "personal-maven-repository-snapshots" + setUrl("https://raw.githubusercontent.com/[组织名或用户名]/[存储库名]/[分支名]/repository/snapshots") + } +} +``` + +你还可以使用 [SweetDependency](https://github/HighCapable/SweetDependency) 统一管理并设置存储库。 + +```yaml +repositories: + personal-maven-repository-releases: + url: https://raw.githubusercontent.com/[组织名或用户名]/[存储库名]/[分支名]/repository/releases + personal-maven-repository-snapshots: + url: https://raw.githubusercontent.com/[组织名或用户名]/[存储库名]/[分支名]/repository/snapshots +``` + +#### 发布工件到存储库 + +推荐使用 vanniktech 的 [gradle-maven-publish-plugin](https://vanniktech.github.io/gradle-maven-publish-plugin) 来发布 Maven 工件。 + +下面是一个配置发布到的存储库方式的参考。 + +你可以直接将存储库发布到本机用户目录下的 `.gradle/personal-maven-repository` 目录中，然后将 `personal-maven-repository` 设置为 git 存储库。 + +将 `personal-maven-repository` 目录连接到 GitHub。 + +每次发布工件后，进行一次 `git commit` 和 `git push` 即可同步当前存储库。 + +```kotlin +publishing { + repositories { + val repositoryDir = gradle.gradleUserHomeDir + .resolve("personal-maven-repository") + .resolve("repository") + maven { + name = "PersonalMavenReleases" + url = repositoryDir.resolve("releases").toURI() + } + maven { + name = "PersonalMavenSnapShots" + url = repositoryDir.resolve("snapshots").toURI() + } + } +} +``` + +## License + +- [Apache-2.0](https://www.apache.org/licenses/LICENSE-2.0) + +``` +Apache License Version 2.0 + +Copyright (C) 2019-2023 HighCapable + +Licensed under the Apache License, Version 2.0 (the "License"); +you may not use this file except in compliance with the License. +You may obtain a copy of the License at + + https://www.apache.org/licenses/LICENSE-2.0 + +Unless required by applicable law or agreed to in writing, software +distributed under the License is distributed on an "AS IS" BASIS, +WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +See the License for the specific language governing permissions and +limitations under the License. +``` + +Copyright © 2019-2023 HighCapable diff --git a/repository/.gitignore b/repository/.gitignore new file mode 100644 index 0000000..496ee2c --- /dev/null +++ b/repository/.gitignore @@ -0,0 +1 @@ +.DS_Store \ No newline at end of file diff --git a/repository/releases/.gitignore b/repository/releases/.gitignore new file mode 100644 index 0000000..0b9d500 --- /dev/null +++ b/repository/releases/.gitignore @@ -0,0 +1 @@ +# Include this folder \ No newline at end of file diff --git a/repository/snapshots/.gitignore b/repository/snapshots/.gitignore new file mode 100644 index 0000000..0b9d500 --- /dev/null +++ b/repository/snapshots/.gitignore @@ -0,0 +1 @@ +# Include this folder \ No newline at end of file