Skip to content

Commit 048ba7e

Browse files
Docs: Update build script and its description.
1 parent 31dd314 commit 048ba7e

File tree

3 files changed

+22
-3
lines changed

3 files changed

+22
-3
lines changed

devdocs/RELEASE.md

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,12 @@
2828
- `git tag vX.X.X && git push --tags`
2929

3030
##### 5. Re-generate the documentation (HTML)
31-
31+
32+
- To build documentation, you need to be able to access Docker from the console. Check with the command:
33+
```Bash
34+
docker -v
35+
```
36+
3237
- Update `version` in [build.gradle.kts](../build.gradle.kts) for the `dokka` subproject
3338
`"dokka" -> <version>`
3439

docs/build_docs.sh

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,12 @@
11
#!/usr/bin/env bash
22

3+
# Check if Docker is available
4+
if ! command -v docker &> /dev/null
5+
then
6+
printf "ERROR: docker could not be found.\n"
7+
exit 1
8+
fi
9+
310
docker_image="registry.jetbrains.team/p/writerside/builder/writerside-builder:241.16003"
411
instance_id="lpk"
512

docs/update_algolia_index.sh

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,12 @@
11
#!/usr/bin/env bash
22

3+
# Check if Docker is available
4+
if ! command -v docker &> /dev/null
5+
then
6+
printf "ERROR: docker could not be found.\n"
7+
exit 1
8+
fi
9+
310
algolia_app_name="7961PKYRXV"
411
algolia_index_name="lets-plot-kotlin"
512
config_json_product="kotlin"
@@ -22,7 +29,7 @@ while read line; do
2229
fi
2330
done < $root_path/Writerside/v.list
2431
if [ "$config_json_version" = "" ]; then
25-
printf "Error: Cannot read library version.\n"
32+
printf "ERROR: Cannot read library version.\n"
2633
exit 1
2734
fi
2835

@@ -37,7 +44,7 @@ while read line; do
3744
fi
3845
done < $root_path/local.properties
3946
if [ "$aligola_key" = "" ]; then
40-
printf "Error: The Aligola key cannot be empty.\n"
47+
printf "ERROR: The Aligola key cannot be empty.\n"
4148
exit 1
4249
fi
4350

0 commit comments

Comments
 (0)