Skip to content

Commit

Permalink
fix: use correct executable path in generate_docs.sh
Browse files Browse the repository at this point in the history
  • Loading branch information
ivan-p92 committed May 11, 2022
1 parent c37041c commit 9f2965e
Show file tree
Hide file tree
Showing 3 changed files with 9 additions and 9 deletions.
6 changes: 3 additions & 3 deletions pkg/entity/data_connector/cmd.go
Original file line number Diff line number Diff line change
Expand Up @@ -12,9 +12,9 @@ const (
credentialsFileFlag = "credentials-file"
)

var longDoc = `A Data Connector represents a location from and to which data can be read and written. For example, an AWS S3 bucket
or a Google Cloud Storage bucket. By itself, a Data Connector does nothing. A Data Connector with valid credentials is
required when creating a Batch Exporter or Batch Job.
var longDoc = `A Data Connector represents a location from which data can be read, or to which data can be written.
For example, an AWS S3 bucket or a Google Cloud Storage bucket. By itself, a Data Connector does nothing.
A Data Connector with valid credentials is required when creating a Batch Exporter or Batch Job.
### Usage`

Expand Down
2 changes: 1 addition & 1 deletion scripts/generate_docs.sh
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ then
make
./dist/strm --generate-docs > /dev/null 2>&1
else
./dist/strm_linux_amd64/strm --generate-docs > /dev/null 2>&1
./dist/strm_linux_amd64_v1/strm --generate-docs > /dev/null 2>&1
fi

cd generated_docs
Expand Down
10 changes: 5 additions & 5 deletions scripts/publish_docs.sh
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ then
git config --global user.name "${APIS_USERNAME}"
tag_name="${GITHUB_REF##*/}"
else
tag_name="local_test"
tag_name="local_publish"
fi

if [[ $GITHUB_TOKEN == "" ]]
Expand All @@ -17,15 +17,15 @@ then
git checkout -b $tag_name
rm -rf ./docs/cli-reference
cp -rf ../generated_docs ./docs/cli-reference
git add .
git commit -m "add generated docs (cli branch: ${tag_name})"
git add -A
git commit -m "update generated CLI reference docs (CLI version: ${tag_name})"
git push -f origin $tag_name
else
git clone "https://git:${GITHUB_TOKEN}@github.com/strmprivacy/docs.git"
cd docs
rm -rf ./docs/cli-reference
cp -rf ../generated_docs ./docs/cli-reference
git add .
git commit -m "add generated docs (cli branch: ${tag_name})"
git add -A
git commit -m "update generated CLI reference docs (CLI version: ${tag_name})"
git push
fi

0 comments on commit 9f2965e

Please sign in to comment.