Skip to content

Commit 086f3aa

Browse files
committed
Automate publishing Javadoc and deploying extractor.java
1 parent aeac318 commit 086f3aa

File tree

5 files changed

+109
-12
lines changed

5 files changed

+109
-12
lines changed

Diff for: .travis.yml

+31-5
Original file line numberDiff line numberDiff line change
@@ -5,12 +5,38 @@ before_cache:
55
- rm -fr $HOME/.gradle/caches/*/plugin-resolution/
66
cache:
77
directories:
8-
- $HOME/.gradle/caches/
9-
- $HOME/.gradle/wrapper/
8+
- "$HOME/.gradle/caches/"
9+
- "$HOME/.gradle/wrapper/"
1010
deploy:
11+
# Publish Javadoc to GitHub Pages
12+
- provider: pages
13+
skip_cleanup: true
14+
github_token: $GITHUB_ACCESS_TOKEN
15+
local_dir: build/docs/javadoc
16+
keep_history: true
17+
on:
18+
tags: true
19+
20+
# Create a GitHub release
1121
- provider: releases
12-
api_key:
13-
secure: Va5i+Jn2pDMm+65t3rA7rA7AkOl0zmQhecCXkvHTdxq/ETWlWGlt9YBN17wWW8rHQx4BPfN/PSpvisTaevTyWBlc7bVnHJlPOBVYk13El0q8H45EMmNuGZveL9suN7q+l6oZk3ZHA8Y5OCHr7jvnXnMa5XfBM5N1am27lFXrSx/+CsPyVnmP+m2g2U0iLAJNnW4H/eU3hJzKsf9LwbPlLGdH6t1CdOQOhBsMr/yOe3ThRjkRQ49XGwl8XXewkA7AsItGUxBQkAqMBwv5NuiGCcNK7oiiDGI8z8ZDZasedHzWlx9NgIdCLv6XGXV/5UK/MsuFjF2V+Bx4WRryh7ERwjMmcucutEejpxO/zlPwdKD6nCmcYZQmR9ITlp2v1Efn41p7x/uyFfmIGJGNTJ3hLK5uHPQSn+ahCbF/0y5Mbwz3u8U0mYxukOKHRoJs812ubezsM2IOvyPCkYtBiSHVLB13l9uuWZfVU85nUuyHzcLMacIvqic7YxDgbbP4c4ZW8kYeHONRGu+sgWj00iLMRClcjR+UdjISEqBxa36XCxUVaHq3btVnhiUq37YBLoorEtxN1Pz27JGAmxDlTm9s3cx4FLW+A1CbAg17D6eg9tqziOkcBEzAkAD0DvH/GWEZkuSuE3aiujJTc7qhOWONU3WR062Ow/c6QU2bCMpQPOs=
22+
api_key: $GITHUB_ACCESS_TOKEN
23+
on:
24+
tags: true
25+
26+
# Trigger JitPack to build
27+
- provider: script
28+
script: .travis/jitpack.sh $TRAVIS_TAG
29+
on:
30+
tags: true
31+
32+
# Trigger Travis CI to deploy `extractor.java`
33+
- provider: script
34+
script: .travis/extractor.sh $TRAVIS_TAG $TRAVIS_ACCESS_TOKEN
1435
on:
15-
branch: master
1636
tags: true
37+
env:
38+
global:
39+
# GITHUB_ACCESS_TOKEN
40+
- secure: hEgt5ke7q8FouZlRjKTq6eXWSKOAzEK3Li8ffBl7WdcXgorRH7C6dY4aXldHNaG4+R2FCOSzwf8ke5XYZRJT/J45QKWAapJ/hTOqzjD2kWBf0sBcshLrSsyKWx3o6n0jaO8Owv+pgw0f4IcEIOoGW0Lj6Sq1RmErn6i8Whi9FIV9BSKG/ICpyPA+iqqpwYdZzP87D/w4wrlYzSOwLfmM08m46n/xsBiazNFH+Urj4/a9Lo2doA6FoCcFyc8wPQ0naX/y1Mj2UyJdlhVAqgmHGZ06DWpl8sUAXos/gCLOrSRgittjyDh+echRsziIJCBuIHdx1vSyUWiGpLzrb42FM6QuD0GoqqXbK84dm9rdK43rO/jBbGgib5xJK3itguqRk6BlSgMoYMZ5Fiv4uo42UDwgz+XF6xfw84eJdbwk+GtGzN5VgH9Qgnkl6sDsEkvPUAR6tlXvqP8s9Jkvkc4Xte4pXDL/m8Penv3ZBfwGsQQXB6tYEVS452HbhqPPRgrGM0LTGXIf/GyfLq2wEl1xVHZNcb7IP/I61X5A6B9szhtITqft6YEmAgyB8wdoQh8g/7pl8cFIh1kRvzS/MzMBaYhORS1kDbukYFLvscVwLwedUohsNlfpek744E1OUP26YYxwPF1NU2ym1R/hZ/M8O/C2gwAa8bZtRKQcQDDv/GY=
41+
# TRAVIS_ACCESS_TOKEN
42+
- secure: r2CXlCj8MkmlF+TPpBaRXy8Kl7leMAY5LrkUcQ4dU0MvCoAH1oGmGTitCIfjny0AFhCaGZu7jelTGI2SqZ115c1HYF/e4sXglrXWRU84LZjR+zro8hHmGTXrYZfhO5zYHmQYU6CfO8N5LWFlAzPgxrgRVJRKTyxv1JEc/dhIY0zjdbxE4cdCCIsLykPA6YG65w8OJbMnP4iZugmoBumh+Nr51bg8Ml72new8z6amVjKQC+xBVdwR+WWHPa7OE77B5eRd55jlLuUc9P8KZjYXm5VMVEQJnuTtI2X7roTDVszXGNT3cVCJQH44m3H4w1W8GHFU+SBOiyO4Yu0f0ecncvuH/P0LrwGvxotkpZiDK7CIfAoJKrNiCitUcU8ouuE+vX1wLio30L3CkrWxSHryp/MPYQTES1s26MeXuISf2R+twozmXQg/Cnpxw5WS8txzKNbwISlEJVXYMn80qHs7Jk9yGVzxgWEF3TZyWJwupRZbpruzQzz9+khPkyvyZd5kICb+85nL1Pxdbp3IirIoBJ40opnDahFWbx+KAkEx9OcVcxofDGr2gqRu15VW2OPhVE4NMtxMFeXFp+rhec32Pj2nhxk+IU8DwhG26yw/g/uUchIAN/7QXrppPsHY1D6hwtAkdg/42lZdzJHnivebLE58biRlFumBa24i4uyMWXU=

Diff for: .travis/extractor.sh

+29
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
#!/usr/bin/env bash
2+
3+
TRAVIS_TAG=$1
4+
TRAVIS_ACCESS_TOKEN=$2
5+
GITHUB_USER="algorithm-visualizer"
6+
GITHUB_REPO="extractor.java"
7+
8+
BODY="{
9+
\"request\": {
10+
\"branch\": \"master\",
11+
\"config\": {
12+
\"env\": {
13+
\"TRACERS_VERSION\": \"${TRAVIS_TAG}\"
14+
}
15+
}
16+
}
17+
}"
18+
19+
STATUS_CODE=$(curl -s -o /dev/stderr -w "%{http_code}" -X POST \
20+
-H "Content-Type: application/json" \
21+
-H "Accept: application/json" \
22+
-H "Travis-API-Version: 3" \
23+
-H "Authorization: token ${TRAVIS_ACCESS_TOKEN}" \
24+
-d "${BODY}" \
25+
"https://api.travis-ci.com/repo/${GITHUB_USER}%2F${GITHUB_REPO}/requests")
26+
27+
if [[ ${STATUS_CODE} != 2* ]]; then
28+
exit 1
29+
fi

Diff for: .travis/jitpack.sh

+21
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
#!/usr/bin/env bash
2+
3+
TRAVIS_TAG=$1
4+
MAX_RETRIES=42
5+
INTERVAL=5
6+
7+
for (( i=1; i<=MAX_RETRIES; ++i)); do
8+
STATUS_CODE=$(curl -s -o /dev/stderr -w "%{http_code}" \
9+
-H "Content-Type: application/json" \
10+
-H "Accept: application/json" \
11+
-H "Travis-API-Version: 3" \
12+
"https://jitpack.io/org/algorithm-visualizer/tracers.java/${TRAVIS_TAG}/tracers.java-${TRAVIS_TAG}.pom")
13+
if [[ ${STATUS_CODE} == 2* ]]; then
14+
exit 0
15+
fi
16+
echo " (${i}/${MAX_RETRIES})"
17+
if [[ ${i} < ${MAX_RETRIES} ]]; then
18+
sleep ${INTERVAL}
19+
fi
20+
done
21+
exit 1

Diff for: README.md

+27-6
Original file line numberDiff line numberDiff line change
@@ -1,24 +1,45 @@
1-
# tracers.java [![Maven Central](https://img.shields.io/maven-central/v/org.algorithm-visualizer/tracers-java.svg?style=flat-square)](https://search.maven.org/artifact/org.algorithm-visualizer/tracers-java) [![API reference](https://img.shields.io/badge/documentation-java-red.svg?style=flat-square)](https://javadoc.io/doc/org.algorithm-visualizer/tracers-java/) [![Travis (.com)](https://img.shields.io/travis/com/algorithm-visualizer/tracers.java.svg?style=flat-square)](https://travis-ci.com/algorithm-visualizer/tracers.java)
1+
# tracers.java [![JitPack](https://img.shields.io/jitpack/v/github/algorithm-visualizer/tracers.java.svg?style=flat-square)](https://jitpack.io/#org.algorithm-visualizer/tracers.java) [![API reference](https://img.shields.io/badge/documentation-java-red.svg?style=flat-square)](https://algorithm-visualizer.github.io/tracers.java/) [![Travis (.com)](https://img.shields.io/travis/com/algorithm-visualizer/tracers.java.svg?style=flat-square)](https://travis-ci.com/algorithm-visualizer/tracers.java)
22

33
> This repository is part of the project [Algorithm Visualizer](https://github.com/algorithm-visualizer).
44
55
`tracers.java` is a visualization library for Java.
66
You can use it on [algorithm-visualizer.org](https://algorithm-visualizer.org/) or locally on your machine.
77

88
## Installation
9+
### Gradle
10+
1. Add the JitPack repository to `build.gradle`.
11+
```gradle
12+
allprojects {
13+
repositories {
14+
jcenter()
15+
maven { url "https://jitpack.io" }
16+
}
17+
}
18+
```
919
10-
- Gradle
20+
2. Add the dependency.
1121
```gradle
1222
dependencies {
13-
implementation 'org.algorithm-visualizer:tracers-java:+'
23+
implementation 'org.algorithm-visualizer:tracers.java:+'
1424
}
1525
```
1626
17-
- Maven
27+
### Maven
28+
1. Add the JitPack repository to `pom.xml`.
1829
```xml
30+
<repositories>
31+
<repository>
32+
<id>jitpack.io</id>
33+
<url>https://jitpack.io</url>
34+
</repository>
35+
</repositories>
36+
```
37+
38+
2. Add the dependency.
39+
```
1940
<dependency>
2041
<groupId>org.algorithm-visualizer</groupId>
21-
<artifactId>tracers-java</artifactId>
42+
<artifactId>tracers.java</artifactId>
2243
<version>[1.0.0,)</version>
2344
</dependency>
2445
```
@@ -37,7 +58,7 @@ class Main {
3758
}
3859
```
3960

40-
Check out the [API reference](https://javadoc.io/doc/org.algorithm-visualizer/tracers-java/) for more information.
61+
Check out the [API reference](https://algorithm-visualizer.github.io/tracers.java/) for more information.
4162

4263
## Contributing
4364

Diff for: build.gradle

+1-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@ apply plugin: 'java-library'
22
apply plugin: 'maven'
33

44
group = 'org.algorithm-visualizer'
5-
version = '2.3.7'
5+
version = '2.3.8'
66
sourceCompatibility = 1.8
77

88
repositories {

0 commit comments

Comments
 (0)