Skip to content

Commit 5f669bc

Browse files
committed
[CHANGE] automatic readme PR
1 parent 745c296 commit 5f669bc

File tree

2 files changed

+4
-1
lines changed

2 files changed

+4
-1
lines changed

.github/workflows/release.yaml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,7 @@ jobs:
3333
run: |
3434
set -e
3535
echo "Start."
36+
SKIP_GENERATE_FEATURE_DOCS="true" bin/generate_readme
3637
# Configure git and Push updates
3738
git config --global user.email github-actions[bot]@users.noreply.github.com
3839
git config --global user.name github-actions[bot]
@@ -41,6 +42,7 @@ jobs:
4142
git checkout -b $branch
4243
message='Automated documentation update'
4344
# Add / update and commit
45+
git add README.md
4446
git add */**/README.md
4547
git commit -m 'Automated documentation update [skip ci]' || export NO_UPDATES=true
4648
# Push

bin/generate_readme

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,7 @@ SCRIPT_PATH=$( cd -- "$( dirname -- "${BASH_SOURCE[0]}" )" &> /dev/null && pwd )
88
BASE_PATH=$( cd -- "$( dirname -- "${SCRIPT_PATH}" )" &> /dev/null && pwd )
99
SOURCE_PATH="$BASE_PATH/src"
1010
TEMPLATE_PATH="$BASE_PATH/.templates"
11+
SKIP_GENERATE_FEATURE_DOCS="${SKIP_GENERATE_FEATURE_DOCS:-false}"
1112

1213
cd $BASE_PATH
1314

@@ -18,7 +19,7 @@ join_array() {
1819
}
1920

2021
# re-generate docs for all features (just to be sure)
21-
$SCRIPT_PATH/generate_docs
22+
[ "$SKIP_GENERATE_FEATURE_DOCS" != "true" ] && $SCRIPT_PATH/generate_docs
2223

2324
featureList=
2425
firstLine="true"

0 commit comments

Comments
 (0)