-
Notifications
You must be signed in to change notification settings - Fork 622
Add Diff Javadoc workflow #4426
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from 1 commit
Commits
Show all changes
10 commits
Select commit
Hold shift + click to select a range
9320d83
Add diff javadoc workflow
emilypgoogle 6052c10
Minor tweaks
emilypgoogle d5f614c
Revert checkout order change
emilypgoogle d5f0021
Revert incorrect changes
emilypgoogle 7b1d193
Modify ChangedModulesTask
emilypgoogle 9d3ce79
Only compare modified SDKs
emilypgoogle 1a6bc52
Change build order
emilypgoogle a1364bb
Add fetch depth
emilypgoogle ecc6ad5
Fix typo
emilypgoogle 1e4a34c
Only Firebase SDKs
emilypgoogle File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,58 @@ | ||
name: Diff Javadoc | ||
|
||
on: | ||
pull_request: | ||
|
||
jobs: | ||
build: | ||
runs-on: ubuntu-22.04 | ||
permissions: | ||
pull-requests: write | ||
steps: | ||
- name: Make Dir | ||
run: mkdir ~/diff | ||
|
||
- uses: actions/checkout@v3 | ||
emilypgoogle marked this conversation as resolved.
Show resolved
Hide resolved
|
||
with: | ||
ref: ${{ github.base_ref }} | ||
|
||
- name: Set up JDK 11 | ||
emilypgoogle marked this conversation as resolved.
Show resolved
Hide resolved
|
||
uses: actions/setup-java@v2 | ||
with: | ||
java-version: 11 | ||
distribution: temurin | ||
cache: gradle | ||
|
||
- name: Build | ||
run: ./gradlew kotlindoc | ||
emilypgoogle marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
- name: Move original docs | ||
run: mv build ~/diff/original | ||
|
||
- uses: actions/checkout@v3 | ||
|
||
- name: Build | ||
run: ./gradlew kotlindoc | ||
|
||
- name: Move modified docs | ||
run: mv build ~/diff/modified | ||
|
||
- name: Diff docs | ||
run: > | ||
`# Recursively diff directories, including new files, git style, with 3 lines of context` | ||
emilypgoogle marked this conversation as resolved.
Show resolved
Hide resolved
|
||
diff -wEburN ~/diff/original ~/diff/modified | ||
`# Remove the first line and new file signifier of the output` | ||
| tail -n +2 | ||
`# Replace the diff new file signifier with the end and start of a new codeblock` | ||
| sed "s/^diff.*$/\`\`\`\\n\`\`\`diff/g" | ||
`# Add a collapsable block, summary, and start the first code block on the first line` | ||
| sed "1s/^/<details>\\n<summary>Javadoc Changes:<\/summary>\\n\\n\`\`\`diff\\n/" | ||
`# Close the final code block and close the collapsable on the final line` | ||
| sed "$ s/$/\\n\`\`\`\\n<\/details>/" | ||
`# Write to diff.md for later` | ||
> diff.md | ||
|
||
- name: Add comment | ||
uses: mshick/add-pr-comment@v2 | ||
with: | ||
message-path: diff.md |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.