Skip to content

Commit 3fc0d1e

Browse files
cowwoccowwoc
committed
Publish Javadoc to docs directory
1 parent 1e3fb24 commit 3fc0d1e

File tree

98 files changed

+13238
-22
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

98 files changed

+13238
-22
lines changed

‎.github/workflows/deploy_to_maven_central.yml‎

Lines changed: 36 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,7 @@ concurrency:
99
cancel-in-progress: true
1010
permissions:
1111
contents: write
12+
pages: write
1213
id-token: write
1314

1415
env:
@@ -22,7 +23,6 @@ jobs:
2223
runs-on: ubuntu-latest
2324
outputs:
2425
INITIAL_MAIN_POSITION: ${{ steps.create-tag.outputs.INITIAL_MAIN_POSITION }}
25-
INITIAL_GH_PAGES_POSITION: ${{ steps.create-tag.outputs.INITIAL_GH_PAGES_POSITION }}
2626
TAG: ${{ steps.create-tag.outputs.TAG }}
2727
VERSION: ${{ steps.create-tag.outputs.VERSION }}
2828
STAGING_PROFILE_ID: ${{ steps.parse-profile-id.outputs.STAGING_PROFILE_ID }}
@@ -150,20 +150,46 @@ jobs:
150150
- name: Generate Javadoc
151151
run: |
152152
./mvnw --batch-mode -V -e javadoc:aggregate
153-
mkdir --parents "${{ needs.open-release.outputs.VERSION }}/docs"
154-
mv target/reports/apidocs "${{ needs.open-release.outputs.VERSION }}/docs/api"
153+
VERSION=${{ needs.open-release.outputs.VERSION }}
154+
rm -rf "docs/api/${VERSION}"
155+
mkdir --parents "docs/api/${VERSION}"
156+
157+
# Move contents recursively, including hidden files.
158+
shopt -s dotglob
159+
mv target/reports/apidocs/* "docs/api/${VERSION}"
155160
156161
- name: Commit changes
157162
run: |
158-
git checkout gh-pages -f
159-
echo "INITIAL_GH_PAGES_POSITION=$(git rev-parse HEAD)" >> "$GITHUB_OUTPUT"
160-
git add "${{ needs.open-release.outputs.VERSION }}/docs/api"
161-
git commit -m "Released version ${{ needs.open-release.outputs.VERSION }}"
163+
git checkout ${{ github.ref_name }} -f
164+
git add "docs/api/${{ needs.open-release.outputs.VERSION }}"
165+
git commit -m "Publishing Javadoc for version ${{ needs.open-release.outputs.VERSION }}"
162166
git push
163167
168+
javadoc:
169+
name: Javadoc
170+
needs: deploy
171+
environment:
172+
name: github-pages
173+
url: ${{ steps.deployment.outputs.page_url }}
174+
runs-on: ubuntu-latest
175+
steps:
176+
- name: Checkout
177+
uses: actions/checkout@v4
178+
with:
179+
ref: ${{ github.ref }}
180+
- name: Setup Pages
181+
uses: actions/configure-pages@v5
182+
- name: Upload artifact
183+
uses: actions/upload-pages-artifact@v3
184+
with:
185+
path: "docs/api"
186+
- name: Deploy to GitHub Pages
187+
id: deployment
188+
uses: actions/deploy-pages@v4
189+
164190
close-release:
165191
name: Close release
166-
needs: [ open-release, deploy ]
192+
needs: [ open-release, deploy, javadoc ]
167193
runs-on: ubuntu-latest
168194
steps:
169195
- uses: actions/checkout@v4
@@ -196,7 +222,7 @@ jobs:
196222
# Cleanup on failure: https://stackoverflow.com/a/74562058/14731
197223
on-failure:
198224
name: On failure
199-
needs: [ open-release, deploy, close-release ]
225+
needs: [ open-release, deploy, javadoc, close-release ]
200226
runs-on: ubuntu-latest
201227
if: ${{ failure() || cancelled() }}
202228
steps:
@@ -239,16 +265,4 @@ jobs:
239265
- name: Delete tag
240266
if: needs.open-release.outputs.TAG != ''
241267
run: |
242-
git push --delete origin ${{ needs.open-release.outputs.TAG }}
243-
244-
- name: Restore the gh-pages ref to its original position
245-
if: needs.open-release.outputs.INITIAL_GH_PAGES_POSITION != ''
246-
run: |
247-
CURRENT_REF_POSITION=$(git rev-parse HEAD)
248-
if [ "${CURRENT_REF_POSITION}" != "${{ needs.open-release.outputs.INITIAL_GH_PAGES_POSITION }}" ]; then
249-
git reset --hard ${{ needs.open-release.outputs.INITIAL_GH_PAGES_POSITION }}
250-
if [ "${{ github.ref_type }}" == "tag" ]; then
251-
git ${{ github.ref_type }} -f ${{ github.ref_name }}
252-
fi
253-
git push -f origin ${{ github.ref_name }}
254-
fi
268+
git push --delete origin ${{ needs.open-release.outputs.TAG }}

‎docs/api/0.1/apidocs/allclasses-index.html‎

Lines changed: 132 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,132 @@
1+
<!DOCTYPE HTML>
2+
<html lang>
3+
<head>
4+
<!-- Generated by javadoc (23) on Wed Jan 01 12:34:41 UTC 2025 -->
5+
<title>All Classes and Interfaces (Docker 0.1 API)</title>
6+
<meta name="viewport" content="width=device-width, initial-scale=1">
7+
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
8+
<meta name="dc.created" content="2025-01-01">
9+
<meta name="description" content="class index">
10+
<meta name="generator" content="javadoc/AllClassesIndexWriter">
11+
<link rel="stylesheet" type="text/css" href="resource-files/jquery-ui.min.css" title="Style">
12+
<link rel="stylesheet" type="text/css" href="resource-files/stylesheet.css" title="Style">
13+
<script type="text/javascript" src="script-files/script.js"></script>
14+
<script type="text/javascript" src="script-files/jquery-3.7.1.min.js"></script>
15+
<script type="text/javascript" src="script-files/jquery-ui.min.js"></script>
16+
</head>
17+
<body class="all-classes-index-page">
18+
<script type="text/javascript">const pathtoroot = "./";
19+
loadScripts(document, 'script');</script>
20+
<noscript>
21+
<div>JavaScript is disabled on your browser.</div>
22+
</noscript>
23+
<header role="banner">
24+
<nav role="navigation">
25+
<!-- ========= START OF TOP NAVBAR ======= -->
26+
<div class="top-nav" id="navbar-top">
27+
<div class="nav-content">
28+
<div class="nav-menu-button"><button id="navbar-toggle-button" aria-controls="navbar-top" aria-expanded="false" aria-label="Toggle navigation links"><span class="nav-bar-toggle-icon">&nbsp;</span><span class="nav-bar-toggle-icon">&nbsp;</span><span class="nav-bar-toggle-icon">&nbsp;</span></button></div>
29+
<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div>
30+
<ul id="navbar-top-firstrow" class="nav-list" title="Navigation">
31+
<li><a href="com.github.cowwoc.docker/module-summary.html">Module</a></li>
32+
<li><a href="overview-tree.html">Tree</a></li>
33+
<li><a href="index-all.html">Index</a></li>
34+
<li><a href="search.html">Search</a></li>
35+
<li><a href="help-doc.html#all-classes">Help</a></li>
36+
</ul>
37+
</div>
38+
</div>
39+
<div class="sub-nav">
40+
<div class="nav-content">
41+
<ol class="sub-nav-list"></ol>
42+
<div class="nav-list-search">
43+
<input type="text" id="search-input" disabled placeholder="Search" aria-label="Search in documentation" autocomplete="off">
44+
<input type="reset" id="reset-search" disabled value="Reset">
45+
</div>
46+
</div>
47+
</div>
48+
<!-- ========= END OF TOP NAVBAR ========= -->
49+
<span class="skip-nav" id="skip-navbar-top"></span></nav>
50+
</header>
51+
<div class="main-grid">
52+
<main role="main">
53+
<div class="header">
54+
<h1 title="All Classes and Interfaces" class="title">All Classes and Interfaces</h1>
55+
</div>
56+
<div id="all-classes-table">
57+
<div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="all-classes-table-tab0" role="tab" aria-selected="true" aria-controls="all-classes-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('all-classes-table', 'all-classes-table', 2)" class="active-table-tab">All Classes and Interfaces</button><button id="all-classes-table-tab1" role="tab" aria-selected="false" aria-controls="all-classes-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('all-classes-table', 'all-classes-table-tab1', 2)" class="table-tab">Interfaces</button><button id="all-classes-table-tab2" role="tab" aria-selected="false" aria-controls="all-classes-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('all-classes-table', 'all-classes-table-tab2', 2)" class="table-tab">Classes</button><button id="all-classes-table-tab3" role="tab" aria-selected="false" aria-controls="all-classes-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('all-classes-table', 'all-classes-table-tab3', 2)" class="table-tab">Enum Classes</button><button id="all-classes-table-tab4" role="tab" aria-selected="false" aria-controls="all-classes-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('all-classes-table', 'all-classes-table-tab4', 2)" class="table-tab">Record Classes</button><button id="all-classes-table-tab5" role="tab" aria-selected="false" aria-controls="all-classes-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('all-classes-table', 'all-classes-table-tab5', 2)" class="table-tab">Exception Classes</button></div>
58+
<div id="all-classes-table.tabpanel" role="tabpanel" aria-labelledby="all-classes-table-tab0">
59+
<div class="summary-table two-column-summary">
60+
<div class="table-header col-first">Class</div>
61+
<div class="table-header col-last">Description</div>
62+
<div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="com.github.cowwoc.docker/com/github/cowwoc/docker/resource/Config.html" title="class in com.github.cowwoc.docker.resource">Config</a></div>
63+
<div class="col-last even-row-color all-classes-table all-classes-table-tab2">
64+
<div class="block">Non-sensitive configuration that is stored in the swarm.</div>
65+
</div>
66+
<div class="col-first odd-row-color all-classes-table all-classes-table-tab1"><a href="com.github.cowwoc.docker/com/github/cowwoc/docker/client/DockerClient.html" title="interface in com.github.cowwoc.docker.client">DockerClient</a></div>
67+
<div class="col-last odd-row-color all-classes-table all-classes-table-tab1">
68+
<div class="block">A client of the Docker REST API.</div>
69+
</div>
70+
<div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="com.github.cowwoc.docker/com/github/cowwoc/docker/resource/Image.html" title="class in com.github.cowwoc.docker.resource">Image</a></div>
71+
<div class="col-last even-row-color all-classes-table all-classes-table-tab2">
72+
<div class="block">A docker image.</div>
73+
</div>
74+
<div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="com.github.cowwoc.docker/com/github/cowwoc/docker/resource/ImageBuilder.html" title="class in com.github.cowwoc.docker.resource">ImageBuilder</a></div>
75+
<div class="col-last odd-row-color all-classes-table all-classes-table-tab2">
76+
<div class="block">Builds an image.</div>
77+
</div>
78+
<div class="col-first even-row-color all-classes-table all-classes-table-tab5"><a href="com.github.cowwoc.docker/com/github/cowwoc/docker/exception/ImageNotFoundException.html" title="class in com.github.cowwoc.docker.exception">ImageNotFoundException</a></div>
79+
<div class="col-last even-row-color all-classes-table all-classes-table-tab5">
80+
<div class="block">Thrown if a referenced image does not exist.</div>
81+
</div>
82+
<div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="com.github.cowwoc.docker/com/github/cowwoc/docker/resource/ImagePusher.html" title="class in com.github.cowwoc.docker.resource">ImagePusher</a></div>
83+
<div class="col-last odd-row-color all-classes-table all-classes-table-tab2">
84+
<div class="block">Pushes an image to a remote repository.</div>
85+
</div>
86+
<div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="com.github.cowwoc.docker/com/github/cowwoc/docker/resource/Node.html" title="class in com.github.cowwoc.docker.resource">Node</a></div>
87+
<div class="col-last even-row-color all-classes-table all-classes-table-tab2">
88+
<div class="block">A docker node.</div>
89+
</div>
90+
<div class="col-first odd-row-color all-classes-table all-classes-table-tab3"><a href="com.github.cowwoc.docker/com/github/cowwoc/docker/resource/Node.Availability.html" title="enum class in com.github.cowwoc.docker.resource">Node.Availability</a></div>
91+
<div class="col-last odd-row-color all-classes-table all-classes-table-tab3">
92+
<div class="block">Indicates if the node is available to run tasks.</div>
93+
</div>
94+
<div class="col-first even-row-color all-classes-table all-classes-table-tab3"><a href="com.github.cowwoc.docker/com/github/cowwoc/docker/resource/Node.Reachability.html" title="enum class in com.github.cowwoc.docker.resource">Node.Reachability</a></div>
95+
<div class="col-last even-row-color all-classes-table all-classes-table-tab3">
96+
<div class="block">Indicates if it is possible to communicate with the node.</div>
97+
</div>
98+
<div class="col-first odd-row-color all-classes-table all-classes-table-tab3"><a href="com.github.cowwoc.docker/com/github/cowwoc/docker/resource/Node.State.html" title="enum class in com.github.cowwoc.docker.resource">Node.State</a></div>
99+
<div class="col-last odd-row-color all-classes-table all-classes-table-tab3">
100+
<div class="block">Indicates the overall health of the node.</div>
101+
</div>
102+
<div class="col-first even-row-color all-classes-table all-classes-table-tab4"><a href="com.github.cowwoc.docker/com/github/cowwoc/docker/resource/Node.Status.html" title="class in com.github.cowwoc.docker.resource">Node.Status</a></div>
103+
<div class="col-last even-row-color all-classes-table all-classes-table-tab4">
104+
<div class="block">The overall health of the node.</div>
105+
</div>
106+
<div class="col-first odd-row-color all-classes-table all-classes-table-tab3"><a href="com.github.cowwoc.docker/com/github/cowwoc/docker/resource/Node.SwarmRole.html" title="enum class in com.github.cowwoc.docker.resource">Node.SwarmRole</a></div>
107+
<div class="col-last odd-row-color all-classes-table all-classes-table-tab3">
108+
<div class="block">The role of the node within the swarm.</div>
109+
</div>
110+
<div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="com.github.cowwoc.docker/com/github/cowwoc/docker/resource/Server.html" title="class in com.github.cowwoc.docker.resource">Server</a></div>
111+
<div class="col-last even-row-color all-classes-table all-classes-table-tab2">
112+
<div class="block">A docker server.</div>
113+
</div>
114+
<div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="com.github.cowwoc.docker/com/github/cowwoc/docker/resource/Swarm.html" title="class in com.github.cowwoc.docker.resource">Swarm</a></div>
115+
<div class="col-last odd-row-color all-classes-table all-classes-table-tab2">
116+
<div class="block">A docker swarm (cluster).</div>
117+
</div>
118+
<div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="com.github.cowwoc.docker/com/github/cowwoc/docker/resource/Task.html" title="class in com.github.cowwoc.docker.resource">Task</a></div>
119+
<div class="col-last even-row-color all-classes-table all-classes-table-tab2">
120+
<div class="block">A unit of work that executes on a node.</div>
121+
</div>
122+
</div>
123+
</div>
124+
</div>
125+
<footer role="contentinfo">
126+
<hr>
127+
<p class="legal-copy"><small>Copyright &#169; 2025. All rights reserved.</small></p>
128+
</footer>
129+
</main>
130+
</div>
131+
</body>
132+
</html>

‎docs/api/0.1/apidocs/allpackages-index.html‎

Lines changed: 74 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,74 @@
1+
<!DOCTYPE HTML>
2+
<html lang>
3+
<head>
4+
<!-- Generated by javadoc (23) on Wed Jan 01 12:34:41 UTC 2025 -->
5+
<title>All Packages (Docker 0.1 API)</title>
6+
<meta name="viewport" content="width=device-width, initial-scale=1">
7+
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
8+
<meta name="dc.created" content="2025-01-01">
9+
<meta name="description" content="package index">
10+
<meta name="generator" content="javadoc/AllPackagesIndexWriter">
11+
<link rel="stylesheet" type="text/css" href="resource-files/jquery-ui.min.css" title="Style">
12+
<link rel="stylesheet" type="text/css" href="resource-files/stylesheet.css" title="Style">
13+
<script type="text/javascript" src="script-files/script.js"></script>
14+
<script type="text/javascript" src="script-files/jquery-3.7.1.min.js"></script>
15+
<script type="text/javascript" src="script-files/jquery-ui.min.js"></script>
16+
</head>
17+
<body class="all-packages-index-page">
18+
<script type="text/javascript">const pathtoroot = "./";
19+
loadScripts(document, 'script');</script>
20+
<noscript>
21+
<div>JavaScript is disabled on your browser.</div>
22+
</noscript>
23+
<header role="banner">
24+
<nav role="navigation">
25+
<!-- ========= START OF TOP NAVBAR ======= -->
26+
<div class="top-nav" id="navbar-top">
27+
<div class="nav-content">
28+
<div class="nav-menu-button"><button id="navbar-toggle-button" aria-controls="navbar-top" aria-expanded="false" aria-label="Toggle navigation links"><span class="nav-bar-toggle-icon">&nbsp;</span><span class="nav-bar-toggle-icon">&nbsp;</span><span class="nav-bar-toggle-icon">&nbsp;</span></button></div>
29+
<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div>
30+
<ul id="navbar-top-firstrow" class="nav-list" title="Navigation">
31+
<li><a href="com.github.cowwoc.docker/module-summary.html">Module</a></li>
32+
<li><a href="overview-tree.html">Tree</a></li>
33+
<li><a href="index-all.html">Index</a></li>
34+
<li><a href="search.html">Search</a></li>
35+
<li><a href="help-doc.html#all-packages">Help</a></li>
36+
</ul>
37+
</div>
38+
</div>
39+
<div class="sub-nav">
40+
<div class="nav-content">
41+
<ol class="sub-nav-list"></ol>
42+
<div class="nav-list-search">
43+
<input type="text" id="search-input" disabled placeholder="Search" aria-label="Search in documentation" autocomplete="off">
44+
<input type="reset" id="reset-search" disabled value="Reset">
45+
</div>
46+
</div>
47+
</div>
48+
<!-- ========= END OF TOP NAVBAR ========= -->
49+
<span class="skip-nav" id="skip-navbar-top"></span></nav>
50+
</header>
51+
<div class="main-grid">
52+
<main role="main">
53+
<div class="header">
54+
<h1 title="All&amp;nbsp;Packages" class="title">All&nbsp;Packages</h1>
55+
</div>
56+
<div class="caption"><span>Package Summary</span></div>
57+
<div class="summary-table two-column-summary">
58+
<div class="table-header col-first">Package</div>
59+
<div class="table-header col-last">Description</div>
60+
<div class="col-first even-row-color"><a href="com.github.cowwoc.docker/com/github/cowwoc/docker/client/package-summary.html">com.github.cowwoc.docker.client</a></div>
61+
<div class="col-last even-row-color">&nbsp;</div>
62+
<div class="col-first odd-row-color"><a href="com.github.cowwoc.docker/com/github/cowwoc/docker/exception/package-summary.html">com.github.cowwoc.docker.exception</a></div>
63+
<div class="col-last odd-row-color">&nbsp;</div>
64+
<div class="col-first even-row-color"><a href="com.github.cowwoc.docker/com/github/cowwoc/docker/resource/package-summary.html">com.github.cowwoc.docker.resource</a></div>
65+
<div class="col-last even-row-color">&nbsp;</div>
66+
</div>
67+
<footer role="contentinfo">
68+
<hr>
69+
<p class="legal-copy"><small>Copyright &#169; 2025. All rights reserved.</small></p>
70+
</footer>
71+
</main>
72+
</div>
73+
</body>
74+
</html>

0 commit comments

Comments
 (0)