Skip to content

Commit

Permalink
ARROW-14739: [JS] Ensure docs point to right source
Browse files Browse the repository at this point in the history
Closes #11728 from domoritz/dom/docs-build-remote

Lead-authored-by: Dominik Moritz <domoritz@gmail.com>
Co-authored-by: Sutou Kouhei <kou@cozmixng.org>
Signed-off-by: Sutou Kouhei <kou@clear-code.com>
  • Loading branch information
domoritz and kou committed Nov 19, 2021
1 parent de5aa54 commit a25aa8d
Show file tree
Hide file tree
Showing 3 changed files with 15 additions and 1 deletion.
11 changes: 10 additions & 1 deletion ci/scripts/js_build.sh
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,16 @@ yarn lint:ci
yarn build

if [ "${with_docs}" == "true" ]; then
yarn doc
if [ "$(git config --get remote.origin.url)" == "https://github.com/apache/arrow.git" ]; then
yarn doc
elif [ "$(git config --get remote.upstream.url)" == "https://github.com/apache/arrow.git" ]; then
yarn doc --gitRemote upstream
elif [ "$(git config --get remote.apache.url)" == "git@github.com:apache/arrow.git" ]; then
yarn doc --gitRemote apache
else
echo "Failed to build docs because the remote is not set correctly. Please set the origin or upstream remote to https://github.com/apache/arrow.git or the apache remote to git@github.com:apache/arrow.git."
exit 0
fi
fi

popd
1 change: 1 addition & 0 deletions dev/tasks/docker-tests/azure.linux.yml
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,7 @@ jobs:
git -C arrow fetch -t {{ arrow.remote }} {{ arrow.branch }}
git -C arrow checkout FETCH_HEAD
git -C arrow submodule update --init --recursive
git -C arrow remote add upstream https://github.com/apache/arrow.git
displayName: Clone arrow
- script: pip install -e arrow/dev/archery[docker]
Expand Down
4 changes: 4 additions & 0 deletions js/DEVELOP.md
Original file line number Diff line number Diff line change
Expand Up @@ -70,6 +70,10 @@ To run tests directly on the sources without bundling, use the `src` target (e.g

Uses [lerna](https://github.com/lerna/lerna) to publish each build target to npm with [conventional](https://conventionalcommits.org/) [changelogs](https://github.com/conventional-changelog/conventional-changelog/tree/master/packages/conventional-changelog-cli).

* `yarn doc`

Compiles the documentation with [Typedoc](https://typedoc.org/). Use `yarn doc --watch` to automatically rebuild when the docs change.

# Running the Performance Benchmarks

You can run the benchmarks with `yarn perf`. To print the results to stderr as JSON, add the `--json` flag (e.g. `yarn perf --json 2> perf.json`).
Expand Down

0 comments on commit a25aa8d

Please sign in to comment.