Skip to content

Commit 4294946

Browse files
Conf: change doc generation and validation (#112)
1 parent 14f6e94 commit 4294946

6 files changed

+10
-53
lines changed

arrow-libs/fx/.github/workflows/build_doc_arrow-fx.yml

+2-18
Original file line numberDiff line numberDiff line change
@@ -21,21 +21,5 @@ jobs:
2121
with:
2222
java-version: 1.8
2323
architecture: x64
24-
- name: Checkout orchestrator
25-
run: |
26-
cd $BASEDIR
27-
git clone https://github.com/arrow-kt/arrow.git
28-
- name: Run Ank for site
29-
run: |
30-
$BASEDIR/arrow/scripts/site-download.sh
31-
$BASEDIR/arrow/scripts/site-run-ank.sh
32-
- name: Run Dokka for arrow-fx
33-
run: $BASEDIR/arrow/scripts/project-run-dokka.sh arrow-fx
34-
- name: Run Ank for arrow-fx
35-
run: $BASEDIR/arrow/scripts/project-run-ank.sh arrow-fx
36-
- name: Join docs to site
37-
run: $BASEDIR/arrow/scripts/project-locate-doc.sh arrow-fx
38-
- name: Prepare environment
39-
run: $BASEDIR/arrow/scripts/site-prepare-env.sh
40-
- name: Build site
41-
run: $BASEDIR/arrow/scripts/site-build.sh
24+
- name: Generate API doc and validate
25+
run: ./gradlew buildArrowDoc

arrow-libs/fx/.github/workflows/check_build_integration.yml

+2-8
Original file line numberDiff line numberDiff line change
@@ -25,14 +25,8 @@ jobs:
2525
if: failure()
2626
id: create-issue
2727
run: |
28-
echo $(git log -1 --pretty=format:%s)
29-
echo ::set-output name=title::$(git log -1 --pretty=format:%s | sed 's/"//g')
30-
echo -e "## Details\n" > issue.log
31-
echo -e "* **Commit hash**: \`$(git log -1 --pretty=format:%h)\`\n" >> issue.log
32-
echo -e "* **Author**: $(git log -1 --pretty=format:%an)\n" >> issue.log
33-
echo -e "* **Committer**: $(git log -1 --pretty=format:%cn)\n" >> issue.log
34-
echo -e "* **More info**: [error log](https://github.com/arrow-kt/arrow-fx/commit/$GITHUB_SHA/checks)\n" >> issue.log
35-
cat issue.log
28+
$BASEDIR/arrow/scripts/issue-create-description.sh > issue.log
29+
echo ::set-output name=title::$(git log -1 --pretty=format:%s)
3630
rm -rf /home/runner/work/_actions/actions/github-script/0.3.0/node_modules
3731
cd /home/runner/work/_actions/actions/github-script/0.3.0/
3832
npm install

arrow-libs/fx/.github/workflows/check_doc_integration.yml

+2-8
Original file line numberDiff line numberDiff line change
@@ -25,14 +25,8 @@ jobs:
2525
if: failure()
2626
id: create-issue
2727
run: |
28-
echo $(git log -1 --pretty=format:%s)
29-
echo ::set-output name=title::$(git log -1 --pretty=format:%s | sed 's/"//g')
30-
echo -e "## Details\n" > issue.log
31-
echo -e "* **Commit hash**: \`$(git log -1 --pretty=format:%h)\`\n" >> issue.log
32-
echo -e "* **Author**: $(git log -1 --pretty=format:%an)\n" >> issue.log
33-
echo -e "* **Committer**: $(git log -1 --pretty=format:%cn)\n" >> issue.log
34-
echo -e "* **More info**: [error log](https://github.com/arrow-kt/arrow-fx/commit/$GITHUB_SHA/checks)\n" >> issue.log
35-
cat issue.log
28+
$BASEDIR/arrow/scripts/issue-create-description.sh > issue.log
29+
echo ::set-output name=title::$(git log -1 --pretty=format:%s)
3630
rm -rf /home/runner/work/_actions/actions/github-script/0.3.0/node_modules
3731
cd /home/runner/work/_actions/actions/github-script/0.3.0/
3832
npm install

arrow-libs/fx/.github/workflows/publish_arrow-fx.yml

+1-7
Original file line numberDiff line numberDiff line change
@@ -41,14 +41,8 @@ jobs:
4141
if: failure()
4242
id: create-issue
4343
run: |
44-
echo $(git log -1 --pretty=format:%s)
44+
$BASEDIR/arrow/scripts/issue-create-description.sh > issue.log
4545
echo ::set-output name=title::$(git log -1 --pretty=format:%s)
46-
echo -e "## Details\n" > issue.log
47-
echo -e "* **Commit hash**: \`$(git log -1 --pretty=format:%h)\`\n" >> issue.log
48-
echo -e "* **Author**: $(git log -1 --pretty=format:%an)\n" >> issue.log
49-
echo -e "* **Committer**: $(git log -1 --pretty=format:%cn)\n" >> issue.log
50-
echo -e "* **More info**: [error log](https://github.com/arrow-kt/arrow-fx/commit/$GITHUB_SHA/checks)\n" >> issue.log
51-
cat issue.log
5246
rm -rf /home/runner/work/_actions/actions/github-script/0.3.0/node_modules
5347
cd /home/runner/work/_actions/actions/github-script/0.3.0/
5448
npm install

arrow-libs/fx/.github/workflows/publish_doc_arrow-fx.yml

+3-11
Original file line numberDiff line numberDiff line change
@@ -29,10 +29,8 @@ jobs:
2929
run: |
3030
$BASEDIR/arrow/scripts/site-download.sh
3131
$BASEDIR/arrow/scripts/site-run-ank.sh
32-
- name: Run Dokka for arrow-fx
33-
run: $BASEDIR/arrow/scripts/project-run-dokka.sh arrow-fx
34-
- name: Run Ank for arrow-fx
35-
run: $BASEDIR/arrow/scripts/project-run-ank.sh arrow-fx
32+
- name: Generate API doc and validate
33+
run: ./gradlew buildArrowDoc
3634
- name: Join docs to site
3735
run: $BASEDIR/arrow/scripts/project-locate-doc.sh arrow-fx
3836
- name: Prepare environment
@@ -52,14 +50,8 @@ jobs:
5250
if: failure()
5351
id: create-issue
5452
run: |
55-
echo $(git log -1 --pretty=format:%s)
53+
$BASEDIR/arrow/scripts/issue-create-description.sh > issue.log
5654
echo ::set-output name=title::$(git log -1 --pretty=format:%s)
57-
echo -e "## Details\n" > issue.log
58-
echo -e "* **Commit hash**: \`$(git log -1 --pretty=format:%h)\`\n" >> issue.log
59-
echo -e "* **Author**: $(git log -1 --pretty=format:%an)\n" >> issue.log
60-
echo -e "* **Committer**: $(git log -1 --pretty=format:%cn)\n" >> issue.log
61-
echo -e "* **More info**: [error log](https://github.com/arrow-kt/arrow-fx/commit/$GITHUB_SHA/checks)\n" >> issue.log
62-
cat issue.log
6355
rm -rf /home/runner/work/_actions/actions/github-script/0.3.0/node_modules
6456
cd /home/runner/work/_actions/actions/github-script/0.3.0/
6557
npm install

arrow-libs/fx/settings.gradle

-1
Original file line numberDiff line numberDiff line change
@@ -9,4 +9,3 @@ include 'arrow-benchmarks-fx:arrow-scala-benchmarks'
99
include 'arrow-benchmarks-fx:arrow-kio-benchmarks'
1010
include 'arrow-benchmarks-fx'
1111
include 'arrow-fx-test'
12-
include 'arrow-docs'

0 commit comments

Comments
 (0)