1
mirror of https://github.com/CarmJos/GithubReleases4J.git synced 2026-06-04 21:18:16 +08:00

12 Commits

Author SHA1 Message Date
carm e020c07749 Update pom.xml 2023-04-15 12:42:46 +08:00
carm 6d688fb5c4 Merge pull request #3 from CarmJos/dependabot/maven/org.json-json-20230227
Bump json from 20211205 to 20230227
2023-04-15 12:39:22 +08:00
dependabot[bot] 5096003228 Bump json from 20211205 to 20230227
Bumps [json](https://github.com/douglascrockford/JSON-java) from 20211205 to 20230227.
- [Release notes](https://github.com/douglascrockford/JSON-java/releases)
- [Changelog](https://github.com/stleary/JSON-java/blob/master/docs/RELEASES.md)
- [Commits](https://github.com/douglascrockford/JSON-java/commits)

---
updated-dependencies:
- dependency-name: org.json:json
  dependency-type: direct:production
...

Signed-off-by: dependabot[bot] <support@github.com>
2023-04-14 18:09:07 +00:00
carm b60283a9c2 docs: remove minecraft tag 2022-06-07 06:39:45 +08:00
carm 4cc891edc0 Update README.md 2022-02-07 20:05:42 +08:00
carm 8bf0d98c00 Update README_zh_CN.md 2022-02-07 20:04:46 +08:00
carm df72460044 修改构建名 2022-02-07 03:05:09 +08:00
carm 81f621b0a6 修改构建名 2022-02-07 03:04:40 +08:00
carm 6f8452bed8 部署到Central 2022-02-07 03:00:46 +08:00
carm 3b787b8c0f 修改示例代码 2022-01-24 17:40:31 +08:00
carm a6ab32a762 [v1.3.0] [A] 添加中文Demo示例。 2022-01-23 11:15:10 +08:00
carm 2cad1116b9 [v1.3.0] [A] Add update checker demo. 2022-01-22 15:26:44 +08:00
11 changed files with 257 additions and 33 deletions
+41
View File
@@ -0,0 +1,41 @@
-----BEGIN PGP PUBLIC KEY BLOCK-----
mQGNBGHwDt0BDAC+2u7hHXIp+C3tvUc5w7Ga5gDVNN3xTQEurGXgYSnGnNPb89h/
tk6MBQ2AHdsj61yK/mH65RbDZe725+0zBvumxfrPbgqYBy9veE1Cjpl3wJwsGYa+
gidq3tU2WBpUpaFOcyfxzvoDjKv6BClX+m7RijRM4tTSxmzrUTfwrClSdSV2HlBu
AuKvY5W+cDwlKtuXEBtgCpdlOGsp8YZsqe4QD9xMI6GOOnXnHisYnmsMzn2RU8mW
GUS3ob1J1vAfIinixwB8tHlxB/G3jaOXtQEwFmI2dfYOdkbxOiIgcSfbRI8PGiHA
KiluZpn+Ww05GwUch2HdX8dw1hsbWM4G/X8Aqy3HdJB28p73dE4I9FRrJ1uxsmMe
iON8QevhSBC0qwSxb+16vKt58ErQnqXrJI6+HzPldn22OQIF7bMZGwYkZiOjS5LU
xAoRT4Jomks0ccOZGe7wMIUp2Ch22vmv4O78Pd2GEzAcTUvM8mrS+zJBMogjx27C
r86HOWEjmi2R32EAEQEAAbQeQ2FybSBKb3MgPEthcm11bkpAb3V0bG9vay5jb20+
iQHUBBMBCAA+FiEEL6NL2WG27xbAlAIkh337tzeYbfcFAmHwDt0CGwMFCQPCZwAF
CwkIBwIGFQoJCAsCBBYCAwECHgECF4AACgkQh337tzeYbffNvQwAscXykUimCOli
lRK52P6+w5n/arl7UxCh7TZiRjf9feiCp3OivETKCeqnbtNTgv67aNbxjO9asCTK
dU6J6Zh6wO8CqDhg+EA8qn+Nu4ESPGvgyWyeck9otMy16To5/I9eQRYTOos1crOA
DRUH1MWLeIkZabM6wSPad/CcRAzFNf5+8JNuQqCgQ3Rngst1Z6Gyb1hixWnjxc4P
7dFquwbR0D0ojwj0Etqd0c5p0iwyRl2I2QQ1bS3aGqdW0LzM9ixh25HAReg2QH7G
FBQ5PLLXr4UqYQygzwhUtxl2jra0+3ia+D7OBwlgm3QPnlo82Z7nExQUYmemD7jV
3Gc1ELXKSRHKbVjSoGiHWpnSiw4ptLo+tnzhRCHlV+pTS3IbQoPdb/glBOVIkA/j
ksCfbrmC8aXpk1YycAXY2my7BpXsImWAOwPHVsvcB2IpEA2s3VfsZ/IB9z+yih3n
z8mL0BFjKWUV23IOoeRqmt7l8nB7u55Nbjasu0LdTcl2R6swE3fTuQGNBGHwDt0B
DAChLPfZ1njctL8BijLO//Hgvw9E6STJGYgqglNetfdoir+YAwCPQ32K4MsaQKl8
xQelmcOU+5jO2C8wEyNAjmvyKGB2J/IjLEtAlbOn1UltKQ/GhxgMjg0EheY81ZMa
7FDq1TDwYRCN5SMKhl5GF0JJ4OWfg1i7HbpEfkw4mW1pl0/eNdeQaC6qV6EWTsqz
WRbi8DeH1WarSgq/00Za6zxNntLNLoq7jsTbDwTc6pgOp1Z8EcGfI/mcn3moqTxc
o/PLYg+6impCKXVeRUlgGBpJ5YVvR5ACTLS9Tztwho9MpKJ9obXAfwXKyoToHCII
+pTnuzweOfOsrjLsFySnXq8WO2PY9JbNWjveKfk35fGfsrbwU0Vg+m67UahXqA4i
KNvZeA8bG8AXrxUirKLWIj/8AuW8NAKu7ui4YmexldraYUgaoBrqhXZCVe8dNQv+
erzNbmJUCPDauNddnDsCqOoZ8fWyBenDs3NS0TWuvua4/ND+AyVxPeatI4qfS2TD
gnUAEQEAAYkBvAQYAQgAJhYhBC+jS9lhtu8WwJQCJId9+7c3mG33BQJh8A7dAhsM
BQkDwmcAAAoJEId9+7c3mG33znkL/01lWSQOzFd+omzrz0RPqFUksxqQS+CUty0m
/4n9H/K3BLcut+nUNbosNuqPqISoiaV7BGigv0bT+Pu+EQQtyjYOSeibeBadB48w
cYp8k3YJbfinuKApw1Zp9IfAd3eXXWi30OY4FmlsKy6LGnusZ6KS+FzTjU94yN/0
LK05fmBtLN/MQJQyqYIkquzk//diwpsxnv34+10igYaQBAEpPIsmsYwWg+ecCtyx
lJGvmQggBrKvo5EdOGhO9DJAu1WQcFqnUCj5qvL+YKIsMyIwujQH8554P8xfCLFU
a351qs30yWXX4HGMn3o7RuVQAACs1buxlMen/JEdQOLOaUtFcu2iYzCFhuzDsetc
geNinFyo0bV9dXiahG95oTL45OA0w+E9Y0B5VXc9Yf08Yyj8ayMChASfVG5lZU6l
KhiaKHV9t4xmwP43lRjs8HTC5rtXc31kPtOAT61HG9vPA49ZdXybUqoHru15PFmc
OK7d0W/LdJ3iFeselROADHgPQn14sg==
=rRA5
-----END PGP PUBLIC KEY BLOCK-----
+37 -12
View File
@@ -1,7 +1,7 @@
# This workflow will build a Java project with Maven, and cache/restore any dependencies to improve the workflow execution time
# For more information see: https://help.github.com/actions/language-and-framework-guides/building-and-testing-java-with-maven
name: Deploy & Upload
name: "Deploy & Upload"
on:
# 支持手动触发构建
@@ -11,8 +11,8 @@ on:
types: [ published ]
jobs:
build:
gh-deploy:
name: "Publish Project (GitHub)"
runs-on: ubuntu-latest
steps:
@@ -29,14 +29,14 @@ jobs:
gpg-private-key: ${{ secrets.MAVEN_GPG_PRIVATE_KEY }} # Value of the GPG private key to import
gpg-passphrase: MAVEN_GPG_PASSPHRASE # env variable for GPG private key passphrase
- name: "Maven Deploy"
run: mvn -B deploy --file pom.xml -DskipTests
- name: "Maven Deploy With Javadoc"
run: mvn -B -Pgithub deploy --file pom.xml -DskipTests
env:
MAVEN_USERNAME: ${{ github.repository_owner }}
MAVEN_TOKEN: ${{secrets.GITHUB_TOKEN}} # env variable for gpg signing in deploy
MAVEN_TOKEN: ${{secrets.GITHUB_TOKEN}}
MAVEN_GPG_PASSPHRASE: ${{ secrets.MAVEN_GPG_PASSPHRASE }}
- name: "Javadoc Deploy Staging"
- name: "Copy Javadoc to Location"
run: |
rm -rf docs
mkdir -vp docs
@@ -47,10 +47,10 @@ jobs:
id: sitemap
uses: cicirello/generate-sitemap@v1
with:
base-url-path: https://${{ github.repository_owner }}.github.io/${{ github.event.repository.name }}
base-url-path: https://carmjos.github.io/GithubReleases4J
path-to-root: docs
- name: "Output Javadoc stats"
- name: "Output stats"
run: |
echo "sitemap-path = ${{ steps.sitemap.outputs.sitemap-path }}"
echo "url-count = ${{ steps.sitemap.outputs.url-count }}"
@@ -68,11 +68,11 @@ jobs:
git config --global user.name 'CarmJos'
git config --global user.email 'carm@carm.cc'
- name: "Commit Javadocs"
- name: "Commit documentations"
run: |
cd docs
git init
git remote add origin git@github.com:${{ github.repository }}.git
git remote add origin git@github.com:CarmJos/GithubReleases4J.git
git checkout -b gh-pages
git add -A
git commit -m "API Document generated."
@@ -80,4 +80,29 @@ jobs:
- name: "Push javadocs"
run: |
cd docs
git push origin HEAD:gh-pages --force
git push origin HEAD:gh-pages --force
central-deploy:
name: "Deploy Project (Central)"
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
- name: "Set up JDK"
uses: actions/setup-java@v2
with:
java-version: '11'
distribution: 'adopt'
cache: maven
server-id: ossrh
server-username: MAVEN_USERNAME
server-password: MAVEN_PASSWORD
gpg-private-key: ${{ secrets.MAVEN_GPG_PRIVATE_KEY }} # Value of the GPG private key to import
gpg-passphrase: MAVEN_GPG_PASSPHRASE # env variable for GPG private key passphrase
- name: "Central Deploy"
run: mvn -B -Possrh deploy --file pom.xml -DskipTests
env:
MAVEN_USERNAME: ${{ secrets.OSSRH_USER }}
MAVEN_PASSWORD: ${{ secrets.OSSRH_PASS }}
MAVEN_GPG_PASSPHRASE: ${{ secrets.MAVEN_GPG_PASSPHRASE }}
+1 -1
View File
@@ -1,7 +1,7 @@
# This workflow will build a Java project with Maven, and cache/restore any dependencies to improve the workflow execution time
# For more information see: https://help.github.com/actions/language-and-framework-guides/building-and-testing-java-with-maven
name: Project Build & Tests
name: Build & Tests
on:
# 支持手动触发构建
+15 -1
View File
@@ -16,7 +16,6 @@ README LANGUAGES [ [**ENGLISH**](README.md) | [中文](README_zh_CN.md) ]
[![License](https://img.shields.io/github/license/CarmJos/GithubReleases4J)](https://opensource.org/licenses/GPL-3.0)
[![workflow](https://github.com/CarmJos/GithubReleases4J/actions/workflows/maven.yml/badge.svg?branch=master)](https://github.com/CarmJos/GithubReleases4J/actions/workflows/maven.yml)
![CodeSize](https://img.shields.io/github/languages/code-size/CarmJos/GithubReleases4J)
![Support](https://img.shields.io/badge/Minecraft-Java%201.16--Latest-green)
![](https://visitor-badge.glitch.me/badge?page_id=GithubReleases4J.readme)
GitHub Releases for Java , based on [GitHub REST API](https://docs.github.com/cn/rest/reference/releases) .
@@ -39,6 +38,7 @@ To provide an easy way to fetch updates and download assets.
- Size
- ...
- Release's Assets Download
- Update check methods. (See demo)
## Dependency Usage
@@ -49,21 +49,32 @@ To provide an easy way to fetch updates and download assets.
<project>
<repositories>
<repository>
<!--Using central repository-->
<id>maven</id>
<name>Maven Central</name>
<url>https://repo1.maven.org/maven2</url>
</repository>
<repository>
<!--Using github packages-->
<id>GithubReleases4J</id>
<name>GitHub Packages</name>
<url>https://maven.pkg.github.com/CarmJos/GithubReleases4J</url>
</repository>
</repositories>
<dependencies>
<dependency>
<groupId>cc.carm.lib</groupId>
<artifactId>githubreleases4j</artifactId>
<version>[LATEST RELEASE]</version>
<scope>compile</scope>
</dependency>
</dependencies>
</project>
@@ -76,6 +87,9 @@ To provide an easy way to fetch updates and download assets.
```groovy
repositories {
mavenCentral() // Using central repository.
// Using github packages.
maven { url 'https://maven.pkg.github.com/CarmJos/GithubReleases4J' }
}
+18 -2
View File
@@ -41,27 +41,39 @@ GitHub Releases for Java , 基于 [GitHub REST API](https://docs.github.com/cn/r
<project>
<repositories>
<repository>
<!--采用Maven中心库,安全稳定,但版本更新需要等待同步-->
<id>maven</id>
<name>Maven Central</name>
<url>https://repo1.maven.org/maven2</url>
</repository>
<repository>
<!--采用github依赖库,安全稳定,但需要配置 (推荐)-->
<id>GithubReleases4J</id>
<name>GitHub Packages</name>
<url>https://maven.pkg.github.com/CarmJos/GithubReleases4J</url>
</repository>
<repository>
<!--采用我的私人依赖库,简单方便,但可能因为变故而无法使用-->
<id>carm-repo</id>
<name>Carm's Repo</name>
<url>https://repo.carm.cc/repository/maven-public/</url>
</repository>
</repositories>
<dependencies>
<dependency>
<groupId>cc.carm.lib</groupId>
<artifactId>githubreleases4j</artifactId>
<version>[LATEST RELEASE]</version>
<scope>compile</scope>
</dependency>
</dependencies>
</project>
@@ -74,6 +86,10 @@ GitHub Releases for Java , 基于 [GitHub REST API](https://docs.github.com/cn/r
```groovy
repositories {
// 采用Maven中心库,安全稳定,但版本更新需要等待同步
mavenCentral()
// 采用github依赖库,安全稳定,但需要配置 (推荐)
maven { url 'https://maven.pkg.github.com/CarmJos/GithubReleases4J' }
@@ -90,7 +106,7 @@ dependencies {
## 开发示例
请 [**点击这里**](src/test/java/GithubDemo.java) 查看示例代码。
请 [**点击这里**](src/test/java/GithubDemoChinese.java) 查看示例代码,也可以 [点击这里](https://github.com/CarmJos/UltraDepository/blob/master/src/main/java/cc/carm/plugin/ultradepository/hooker/UpdateChecker.java) 查看实例项目
## 支持与捐赠
@@ -115,4 +131,4 @@ dependencies {
> MIT 协议是所有开源许可中最宽松的一个,除了必须包含许可声明外,再无任何限制。
>
> *以上文字来自 [五种开源协议GPL,LGPL,BSD,MIT,Apache](https://www.oschina.net/question/54100_9455) 。*
</details>
</details>
+33 -8
View File
@@ -14,7 +14,7 @@
<groupId>cc.carm.lib</groupId>
<artifactId>githubreleases4j</artifactId>
<version>1.3.0</version>
<version>1.3.2</version>
<name>GithubReleases4J</name>
<description>Github Releases for Java</description>
@@ -53,11 +53,6 @@
<name>Github Pages</name>
<url>https://CarmJos.github.io/GithubReleases4J</url>
</site>
<repository>
<id>github</id>
<name>GitHub Packages</name>
<url>https://maven.pkg.github.com/CarmJos/GithubReleases4J</url>
</repository>
</distributionManagement>
<scm>
@@ -101,7 +96,7 @@
<dependency>
<groupId>org.json</groupId>
<artifactId>json</artifactId>
<version>20211205</version>
<version>20230227</version>
</dependency>
<dependency>
@@ -239,5 +234,35 @@
</resources>
</build>
<profiles>
</project>
<profile>
<id>ossrh</id>
<distributionManagement>
<snapshotRepository>
<id>ossrh</id>
<url>https://s01.oss.sonatype.org/content/repositories/snapshots</url>
</snapshotRepository>
<repository>
<id>ossrh</id>
<url>https://s01.oss.sonatype.org/service/local/staging/deploy/maven2/</url>
</repository>
</distributionManagement>
</profile>
<profile>
<id>github</id>
<distributionManagement>
<repository>
<id>github</id>
<name>GitHub Packages</name>
<url>https://maven.pkg.github.com/CarmJos/GithubReleases4J</url>
</repository>
</distributionManagement>
</profile>
</profiles>
</project>
+27
View File
@@ -39,4 +39,31 @@ public class GithubDemo {
}
}
public void checkUpdate() {
String owner = "Owner";
String repository = "RepoName";
Integer behindVersions = GithubReleases4J.getVersionBehind(
owner, repository,
"Token",// OAuth token if it is a private repository.
"Current Version Tag"
);
if (behindVersions == null) {
System.out.println("Check failed! Please check updates manually.");
System.out.println("Download at " + GithubReleases4J.getReleasesURL(owner, repository));
} else if (behindVersions == 0) {
System.out.println("Check successfully, Now is up-to-date.");
} else if (behindVersions > 0) {
System.out.println("Outdated! Now behind " + behindVersions + " versions.");
System.out.println("Download latest version at " + GithubReleases4J.getLatestReleaseURL(owner, repository));
} else {
System.out.println("Check failed! Current version doesn't exists.");
System.out.println("Please use original version to avoid security issues.");
System.out.println("Download latest version at " + GithubReleases4J.getLatestReleaseURL(owner, repository));
}
}
}
+70
View File
@@ -0,0 +1,70 @@
import cc.carm.lib.githubreleases4j.GithubAsset;
import cc.carm.lib.githubreleases4j.GithubRelease;
import cc.carm.lib.githubreleases4j.GithubReleases4J;
import cc.carm.lib.githubreleases4j.GithubUser;
import java.io.IOException;
import java.util.List;
public class GithubDemoChinese {
public void demo() {
String owner = "库主(用户名或组织名)";
String repository = "库名";
List<GithubRelease> releases = GithubReleases4J.listReleases("Owner", "RepoName");
// 列出项目中所有发行版
GithubRelease latestRelease = GithubReleases4J.getLatestRelease(
owner, repository, "Token" // 如果是私有项目 则需要输入OAuth token
); // 得到该库的最新发行
if (latestRelease != null) {
List<GithubAsset> assets = latestRelease.getAssets();
// 得到该发行下的所有附件
for (GithubAsset asset : assets) {
try {
asset.download(); // 使用原附件名直接下载
} catch (IOException exception) {
exception.printStackTrace();
}
GithubUser uploader = asset.getUploader(); // 得到附件的上传者
}
GithubUser author = latestRelease.getAuthor(); // 得到该发行的发布者
}
}
public void checkUpdate() {
String owner = "库主(用户名或组织名)";
String repository = "库名";
String version = "当前版本的 TagName";
Integer behindVersions = GithubReleases4J.getVersionBehind(
owner, repository, "Token",// 如果是私有项目 则需要输入OAuth token
version
);
if (behindVersions == null) {
System.out.println("检查更新失败! 请您手动检查版本更新。");
System.out.println("下载地址 " + GithubReleases4J.getReleasesURL(owner, repository));
} else if (behindVersions == 0) {
System.out.println("检查完成,当前已是最新版本。");
} else if (behindVersions > 0) {
System.out.println("发现新版本! 目前已落后 " + behindVersions + " 个版本。");
System.out.println("最新版下载地址 " + GithubReleases4J.getLatestReleaseURL(owner, repository));
} else {
System.out.println("检查更新失败! 当前版本未知,请您使用原生版本以避免安全问题。");
System.out.println("最新版下载地址 " + GithubReleases4J.getLatestReleaseURL(owner, repository));
}
}
}
+13 -7
View File
@@ -18,7 +18,7 @@ public class GithubReleasesTest {
@Test
public void onTest() {
GithubReleases4J.listReleases("CarmJos", "EasyPlugin")
GithubReleases4J.listReleases("CarmJos", "GithubReleases4J")
.stream().limit(2).forEach(GithubReleasesTest::printInfo);
GithubRelease release = GithubReleases4J.getLatestRelease("CarmJos", "UltraDepository");
@@ -32,16 +32,18 @@ public class GithubReleasesTest {
private static void printInfo(@Nullable GithubRelease release) {
if (release == null) System.out.println("# NULL");
else {
System.out.println("# " + release.getName() + " [" + FORMAT.format(release.getCreateTime()) + "]");
print("# %s %s [%s] ",
release.getRepository(), release.getName(),
FORMAT.format(release.getCreateTime())
);
List<GithubAsset> assets = release.getAssets();
assets.forEach(GithubReleasesTest::printAssets);
}
}
private static void printAssets(@Nullable GithubAsset assets) {
if (assets == null) System.out.println("- NULL");
else {
System.out.println("- " + assets.getName() + " [" + assets.getSize() + "]");
if (assets != null) {
print("- %s (%s B)", assets.getName(), assets.getSize());
}
}
@@ -49,12 +51,16 @@ public class GithubReleasesTest {
if (!DOWNLOAD) return;
if (assets == null) return;
try {
File file = assets.download();
System.out.println("- at " + file.getAbsolutePath());
File file = assets.download(StandardCopyOption.REPLACE_EXISTING);
System.out.println("| -> " + file.getAbsolutePath());
} catch (IOException e) {
e.printStackTrace();
}
}
private static void print(String format, Object... params) {
System.out.printf((format) + "%n", params);
}
}
@@ -5,7 +5,7 @@ import org.junit.Test;
import java.text.SimpleDateFormat;
public class GithubUserTestTest {
public class GithubUserInfoTest {
public static final SimpleDateFormat FORMAT = new SimpleDateFormat("yyyy-MM-dd HH:mm:ss");
@@ -1,7 +1,7 @@
import cc.carm.lib.githubreleases4j.GithubReleases4J;
import org.junit.Test;
public class GithubVersionTest {
public class GithubVersionCheckerTest {
@Test