Skip to content

Commit b6dd526

Browse files
committed
Clarify naming in diff workflow
1 parent c308b4d commit b6dd526

File tree

1 file changed

+8
-6
lines changed

1 file changed

+8
-6
lines changed

.github/workflows/diff-javadoc.yml

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -9,9 +9,10 @@ jobs:
99
permissions:
1010
pull-requests: write
1111
steps:
12-
- name: Make Dir
12+
- name: Make diff directory
1313
run: mkdir ~/diff
1414

15+
- name: Checkout PR branch
1516
- uses: actions/checkout@v3
1617
with:
1718
fetch-depth: 2
@@ -24,23 +25,24 @@ jobs:
2425
distribution: temurin
2526
cache: gradle
2627

27-
- name: Build
28+
- name: Generate docs for PR branch
2829
run: ./gradlew kotlindoc
2930

30-
- name: Move original docs
31+
- name: Move branch docs to diff directory
3132
run: mv build ~/diff/modified
3233

34+
- name: Checkout master
3335
- uses: actions/checkout@v3
3436
with:
3537
ref: ${{ github.base_ref }}
3638

37-
- name: Build
39+
- name: Generate docs for Master
3840
run: ./gradlew kotlindoc
3941

40-
- name: Move modified docs
42+
- name: Move master docs to diff directory
4143
run: mv build ~/diff/original
4244

43-
- name: Diff docs
45+
- name: Get diff between Master and Branch docs
4446
run: >
4547
`# Recursively diff directories, including new files, git style, with 3 lines of context`
4648
diff -wEburN ~/diff/original ~/diff/modified

0 commit comments

Comments
 (0)