Skip to content

Commit 8affd27

Browse files
plataplata
authored
Travis CI: update JSDoc (PhoenicisOrg#553)
1 parent afe2810 commit 8affd27

32 files changed

+92
-29
lines changed

‎.travis.yml

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,12 @@ matrix:
1515
# push translation updates only for master (PR changes must be committed to master before they are taken into account)
1616
- if [ "$TRAVIS_BRANCH" == "master" ] && [ "$TRAVIS_PULL_REQUEST" == "false" ]; then ./i18n/push_translations.sh; fi
1717

18+
# Update JSDoc
19+
- stage: Update JSDoc
20+
script:
21+
# push JSDoc updates only for master (PR changes must be committed to master before they are taken into account)
22+
- if [ "$TRAVIS_BRANCH" == "master" ] && [ "$TRAVIS_PULL_REQUEST" == "false" ]; then ./push_jsdoc.sh; fi
23+
1824
# Check GitHub Pages
1925
- stage: Check GitHub Pages
2026
os: linux

‎docs/jsdoc/ConfigureWine.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -298,7 +298,7 @@ <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="Configure
298298
<br class="clear">
299299

300300
<footer>
301-
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Sat Apr 07 2018 08:46:54 GMT+0200 (CEST)
301+
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a>
302302
</footer>
303303

304304
<script> prettyPrint(); </script>

‎docs/jsdoc/Engines_Wine_Engine_Object_script.js.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1008,7 +1008,7 @@ <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="Configure
10081008
<br class="clear">
10091009

10101010
<footer>
1011-
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Sat Apr 07 2018 08:46:54 GMT+0200 (CEST)
1011+
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a>
10121012
</footer>
10131013

10141014
<script> prettyPrint(); </script>

‎docs/jsdoc/Engines_Wine_QuickScript_Quick Script_script.js.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -174,7 +174,7 @@ <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="Configure
174174
<br class="clear">
175175

176176
<footer>
177-
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Sat Apr 07 2018 08:46:54 GMT+0200 (CEST)
177+
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a>
178178
</footer>
179179

180180
<script> prettyPrint(); </script>

‎docs/jsdoc/Engines_Wine_Shortcuts_Wine_script.js.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -149,7 +149,7 @@ <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="Configure
149149
<br class="clear">
150150

151151
<footer>
152-
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Sat Apr 07 2018 08:46:54 GMT+0200 (CEST)
152+
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a>
153153
</footer>
154154

155155
<script> prettyPrint(); </script>

‎docs/jsdoc/Engines_Wine_Tools_Configure Wine_script.js.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -61,7 +61,7 @@ <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="Configure
6161
<br class="clear">
6262

6363
<footer>
64-
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Sat Apr 07 2018 08:46:54 GMT+0200 (CEST)
64+
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a>
6565
</footer>
6666

6767
<script> prettyPrint(); </script>

‎docs/jsdoc/Engines_Wine_Tools_Kill Wine Processes_script.js.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -61,7 +61,7 @@ <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="Configure
6161
<br class="clear">
6262

6363
<footer>
64-
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Sat Apr 07 2018 08:46:54 GMT+0200 (CEST)
64+
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a>
6565
</footer>
6666

6767
<script> prettyPrint(); </script>

‎docs/jsdoc/Engines_Wine_Tools_Reboot Wine_script.js.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -61,7 +61,7 @@ <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="Configure
6161
<br class="clear">
6262

6363
<footer>
64-
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Sat Apr 07 2018 08:46:54 GMT+0200 (CEST)
64+
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a>
6565
</footer>
6666

6767
<script> prettyPrint(); </script>

‎docs/jsdoc/Engines_Wine_Tools_Repair Wine Prefix_script.js.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -61,7 +61,7 @@ <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="Configure
6161
<br class="clear">
6262

6363
<footer>
64-
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Sat Apr 07 2018 08:46:54 GMT+0200 (CEST)
64+
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a>
6565
</footer>
6666

6767
<script> prettyPrint(); </script>

‎docs/jsdoc/Engines_Wine_Tools_Wine Registry Editor_script.js.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -61,7 +61,7 @@ <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="Configure
6161
<br class="clear">
6262

6363
<footer>
64-
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Sat Apr 07 2018 08:46:54 GMT+0200 (CEST)
64+
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a>
6565
</footer>
6666

6767
<script> prettyPrint(); </script>

‎docs/jsdoc/Engines_Wine_Tools_Wine Task Manager_script.js.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -61,7 +61,7 @@ <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="Configure
6161
<br class="clear">
6262

6363
<footer>
64-
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Sat Apr 07 2018 08:46:54 GMT+0200 (CEST)
64+
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a>
6565
</footer>
6666

6767
<script> prettyPrint(); </script>

‎docs/jsdoc/Engines_Wine_Tools_Wine Terminal Opener_script.js.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -64,7 +64,7 @@ <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="Configure
6464
<br class="clear">
6565

6666
<footer>
67-
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Sat Apr 07 2018 08:46:54 GMT+0200 (CEST)
67+
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a>
6868
</footer>
6969

7070
<script> prettyPrint(); </script>

‎docs/jsdoc/Engines_Wine_Tools_Wine Uninstaller_script.js.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -61,7 +61,7 @@ <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="Configure
6161
<br class="clear">
6262

6363
<footer>
64-
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Sat Apr 07 2018 08:46:54 GMT+0200 (CEST)
64+
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a>
6565
</footer>
6666

6767
<script> prettyPrint(); </script>

‎docs/jsdoc/Engines_Wine_Tools_WineConsole_script.js.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -61,7 +61,7 @@ <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="Configure
6161
<br class="clear">
6262

6363
<footer>
64-
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Sat Apr 07 2018 08:46:54 GMT+0200 (CEST)
64+
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a>
6565
</footer>
6666

6767
<script> prettyPrint(); </script>

‎docs/jsdoc/Engines_Wine_Verbs_dotnet452_script.js.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -96,7 +96,7 @@ <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="Configure
9696
<br class="clear">
9797

9898
<footer>
99-
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Sat Apr 07 2018 08:46:54 GMT+0200 (CEST)
99+
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a>
100100
</footer>
101101

102102
<script> prettyPrint(); </script>

‎docs/jsdoc/Engines_Wine_Verbs_dotnet45_script.js.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -97,7 +97,7 @@ <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="Configure
9797
<br class="clear">
9898

9999
<footer>
100-
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Sat Apr 07 2018 08:46:54 GMT+0200 (CEST)
100+
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a>
101101
</footer>
102102

103103
<script> prettyPrint(); </script>

‎docs/jsdoc/Engines_Wine_Verbs_quartz_script.js.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -80,7 +80,7 @@ <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="Configure
8080
<br class="clear">
8181

8282
<footer>
83-
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Sat Apr 07 2018 08:46:54 GMT+0200 (CEST)
83+
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a>
8484
</footer>
8585

8686
<script> prettyPrint(); </script>

‎docs/jsdoc/Engines_Wine_Verbs_secur32_script.js.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -94,7 +94,7 @@ <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="Configure
9494
<br class="clear">
9595

9696
<footer>
97-
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Sat Apr 07 2018 08:46:54 GMT+0200 (CEST)
97+
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a>
9898
</footer>
9999

100100
<script> prettyPrint(); </script>

‎docs/jsdoc/Engines_Wine_Verbs_xact_script.js.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -218,7 +218,7 @@ <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="Configure
218218
<br class="clear">
219219

220220
<footer>
221-
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Sat Apr 07 2018 08:46:54 GMT+0200 (CEST)
221+
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a>
222222
</footer>
223223

224224
<script> prettyPrint(); </script>

‎docs/jsdoc/KillWineProcesses.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -298,7 +298,7 @@ <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="Configure
298298
<br class="clear">
299299

300300
<footer>
301-
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Sat Apr 07 2018 08:46:54 GMT+0200 (CEST)
301+
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a>
302302
</footer>
303303

304304
<script> prettyPrint(); </script>

‎docs/jsdoc/RebootWine.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -298,7 +298,7 @@ <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="Configure
298298
<br class="clear">
299299

300300
<footer>
301-
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Sat Apr 07 2018 08:46:54 GMT+0200 (CEST)
301+
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a>
302302
</footer>
303303

304304
<script> prettyPrint(); </script>

‎docs/jsdoc/RepairWinePrefix.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -298,7 +298,7 @@ <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="Configure
298298
<br class="clear">
299299

300300
<footer>
301-
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Sat Apr 07 2018 08:46:54 GMT+0200 (CEST)
301+
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a>
302302
</footer>
303303

304304
<script> prettyPrint(); </script>

‎docs/jsdoc/Utils_Functions_Net_Resource_script.js.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -121,7 +121,7 @@ <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="Configure
121121
<br class="clear">
122122

123123
<footer>
124-
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Sat Apr 07 2018 08:46:54 GMT+0200 (CEST)
124+
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a>
125125
</footer>
126126

127127
<script> prettyPrint(); </script>

‎docs/jsdoc/Wine.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6021,7 +6021,7 @@ <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="Configure
60216021
<br class="clear">
60226022

60236023
<footer>
6024-
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Sat Apr 07 2018 08:46:54 GMT+0200 (CEST)
6024+
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a>
60256025
</footer>
60266026

60276027
<script> prettyPrint(); </script>

‎docs/jsdoc/WineConsole.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -298,7 +298,7 @@ <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="Configure
298298
<br class="clear">
299299

300300
<footer>
301-
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Sat Apr 07 2018 08:46:54 GMT+0200 (CEST)
301+
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a>
302302
</footer>
303303

304304
<script> prettyPrint(); </script>

‎docs/jsdoc/WineRegistryEditor.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -298,7 +298,7 @@ <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="Configure
298298
<br class="clear">
299299

300300
<footer>
301-
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Sat Apr 07 2018 08:46:54 GMT+0200 (CEST)
301+
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a>
302302
</footer>
303303

304304
<script> prettyPrint(); </script>

‎docs/jsdoc/WineTaskManager.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -298,7 +298,7 @@ <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="Configure
298298
<br class="clear">
299299

300300
<footer>
301-
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Sat Apr 07 2018 08:46:54 GMT+0200 (CEST)
301+
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a>
302302
</footer>
303303

304304
<script> prettyPrint(); </script>

‎docs/jsdoc/WineTerminalOpener.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -298,7 +298,7 @@ <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="Configure
298298
<br class="clear">
299299

300300
<footer>
301-
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Sat Apr 07 2018 08:46:54 GMT+0200 (CEST)
301+
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a>
302302
</footer>
303303

304304
<script> prettyPrint(); </script>

‎docs/jsdoc/WineUninstaller.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -298,7 +298,7 @@ <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="Configure
298298
<br class="clear">
299299

300300
<footer>
301-
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Sat Apr 07 2018 08:46:54 GMT+0200 (CEST)
301+
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a>
302302
</footer>
303303

304304
<script> prettyPrint(); </script>

‎docs/jsdoc/index.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -56,7 +56,7 @@ <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="Configure
5656
<br class="clear">
5757

5858
<footer>
59-
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Sat Apr 07 2018 08:46:54 GMT+0200 (CEST)
59+
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a>
6060
</footer>
6161

6262
<script> prettyPrint(); </script>

‎jsdoc_conf.json

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
{
2+
"opts": {
3+
"destination": "./docs/jsdoc/",
4+
"recurse": true
5+
},
6+
"plugins": [],
7+
"recurseDepth": 10,
8+
"source": {
9+
"includePattern": ".+\\.js(doc|x)?$",
10+
"excludePattern": "(^|\\/|\\\\)_"
11+
},
12+
"sourceType": "module",
13+
"tags": {
14+
"allowUnknownTags": true,
15+
"dictionaries": ["jsdoc","closure"]
16+
},
17+
"templates": {
18+
"default": {
19+
"includeDate": false
20+
}
21+
}
22+
}
23+
24+

‎push_jsdoc.sh

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
#!/bin/bash
2+
git config --global user.email "[email protected]"
3+
git config --global user.name "Travis CI"
4+
5+
jsdoc -c jsdoc_conf.json .
6+
7+
head_ref=$(git rev-parse HEAD)
8+
if [[ $? -ne 0 || ! $head_ref ]]; then
9+
echo "could not retrieve HEAD reference"
10+
exit 1
11+
fi
12+
branch_ref=$(git rev-parse "$TRAVIS_BRANCH")
13+
if [[ $? -ne 0 || ! $branch_ref ]]; then
14+
echo "could not retrieve $TRAVIS_BRANCH reference"
15+
exit 1
16+
fi
17+
if [[ $head_ref != $branch_ref ]]; then
18+
echo "HEAD ref ($head_ref) does not match $TRAVIS_BRANCH ref ($branch_ref)"
19+
echo "new commits have been added before this build cloned the repository"
20+
exit 0
21+
fi
22+
if [[ $TRAVIS_BRANCH != master ]]; then
23+
echo "will not push JSDoc updates to branch $TRAVIS_BRANCH"
24+
exit 1
25+
fi
26+
git checkout master
27+
git add docs/jsdoc
28+
git commit --message "Update JSDoc"
29+
if ! git push https://$GH_TOKEN@github.com/PhoenicisOrg/scripts.git > /dev/null 2>&1; then
30+
echo "could not push JSDoc updates"
31+
exit 1
32+
fi
33+

0 commit comments

Comments
 (0)