Skip to content

Merge pull request #486 from copystring/dependabot/npm_and_yarn/sentr… #181

Merge pull request #486 from copystring/dependabot/npm_and_yarn/sentr…

Merge pull request #486 from copystring/dependabot/npm_and_yarn/sentr… #181

Workflow file for this run

name: Generate docs
on:
push:
branches:
- main
jobs:
build:
runs-on: ubuntu-latest
if: github.actor != 'github-actions'
steps:
- name: Checkout code
uses: actions/checkout@v4
- name: Setup Node.js
uses: actions/setup-node@v4
with:
node-version: '14'
- name: Install dependencies
run: npm install
- name: Translate JS files
run: node translate_js_files.js
- name: Install jsdoc2md
run: npm install -g jsdoc-to-markdown
- name: Prepare docs folder (make it empty)
run: rm -r docs
- name: Generate documentation
run: |
for genBase in $(cat ./genDirs.txt); do
for lang in $(cat ./languages.txt); do
subDirsCount=$(find ./lib/genSpecs/$genBase/* -maxdepth 0 -type d | wc -l)
if [ "$subDirsCount" -gt "0" ]; then
subDirs=$(ls -d ./lib/genSpecs/$genBase/*/)
for subDir in $subDirs; do
gen="$genBase/$(basename $subDir)"
for jsFile in $(find ./lib/genSpecs/$gen -name "*.js"); do
fileName=$(basename -- $jsFile)
baseName="${fileName%.*}"
outputPath="./docs/$lang/$gen/${baseName}.md"
mkdir -p $(dirname $outputPath)
jsdoc2md --template ./lib/genSpecs/$gen/${baseName}.hbs ./tempTranslated/$gen/${baseName}_${lang}.js > $outputPath
done
done
else
gen=$genBase
for jsFile in $(find ./lib/genSpecs/$gen -name "*.js"); do
fileName=$(basename -- $jsFile)
baseName="${fileName%.*}"
outputPath="./docs/$lang/$gen/${baseName}.md"
mkdir -p $(dirname $outputPath)
jsdoc2md --template ./lib/genSpecs/$gen/${baseName}.hbs ./tempTranslated/$gen/${baseName}_${lang}.js > $outputPath
done
fi
done
done
- name: Cleanup
run: rm -r tempTranslated genDirs.txt languages.txt
- name: Create Pull Request
uses: peter-evans/create-pull-request@v5
with:
token: ${{ secrets.GITHUB_TOKEN }}
commit-message: 'Update JSDoc documentation'
title: 'Update JSDoc documentation'
body: 'This PR updates the documentation.'
branch: 'update-docs'