ambiser
/
openvidu
mirror of https://github.com/OpenVidu/openvidu.git
9
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

components-angular: update generate-docs.sh to use MINOR_VERSION for documentation links

pull/905/head
juancarmore 2026-07-17 11:57:32 +02:00
parent ea335e0715
commit 1345528004
1 changed files with 14 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
openvidu-components-angular/generate-docs.sh
View File

@ -1,12 +1,21 @@
#!/bin/bash
if [[ -z "$BASEHREF_VERSION" ]]; then
echo "Example of use: \"BASEHREF_VERSION=2.12.0 ${0}\"" 1>&2
echo "Example of use: \"BASEHREF_VERSION=3.8.0 ${0}\"" 1>&2
exit 1
fi
# Replace version from "stable" to the specified one in all TypeDoc links
grep -rl '/latest/' projects src | xargs sed -i -e 's|/latest/|/'${BASEHREF_VERSION}'/|g'
# openvidu.io documentation is versioned by MINOR release (folders like "3.8"), so links to
# it must be pinned to the minor version (X.Y). The full X.Y.Z is left untouched: it is the
# library version, read from package.json by Compodoc and shown in the generated docs.
MINOR_VERSION=$(echo "$BASEHREF_VERSION" | grep -oE '^[0-9]+\.[0-9]+')
if [[ -z "$MINOR_VERSION" ]]; then
echo "BASEHREF_VERSION must start with X.Y (e.g. \"BASEHREF_VERSION=3.8.0 ${0}\")" 1>&2
exit 1
fi
# Replace version from "latest" to the specified minor one in all TypeDoc links
grep -rl '/latest/' projects src | xargs sed -i -e 's|/latest/|/'${MINOR_VERSION}'/|g'
# Replace testapp README by openvidu-components-angular README
mv README.md README-testapp.md
@ -15,8 +24,8 @@ cp ./projects/openvidu-components-angular/README.md .
# Generate Compodoc
npm run doc:build
# Return links to "stable" version
grep -rl '/'${BASEHREF_VERSION}'/' projects src | xargs sed -i -e 's|/'${BASEHREF_VERSION}'/|/latest/|g'
# Return links to "latest" version
grep -rl '/'${MINOR_VERSION}'/' projects src | xargs sed -i -e 's|/'${MINOR_VERSION}'/|/latest/|g'
# Undo changes with READMEs
rm README.md
@ -24,4 +33,3 @@ mv README-testapp.md README.md
# Clean previous docs from openvidu.io repo and copy new ones
npm run doc:clean-copy