-
-
Notifications
You must be signed in to change notification settings - Fork 4.6k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
[CI/Build] Add linting for excalidraw exported images
Ensure that PNG images named as excalidraw images were exported with the excalidraw metadata embedded in them. This ensures they are editable in the future. Signed-off-by: Russell Bryant <rbryant@redhat.com>
- Loading branch information
Showing
3 changed files
with
56 additions
and
0 deletions.
There are no files selected for viewing
This file contains 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,37 @@ | ||
name: Lint PNG exports from excalidraw | ||
on: | ||
push: | ||
branches: | ||
- "main" | ||
paths: | ||
- '*.excalidraw.png' | ||
- '.github/workflows/png-lint.yml' | ||
pull_request: | ||
branches: | ||
- "main" | ||
paths: | ||
- '*.excalidraw.png' | ||
- '.github/workflows/png-lint.yml' | ||
|
||
env: | ||
LC_ALL: en_US.UTF-8 | ||
|
||
defaults: | ||
run: | ||
shell: bash | ||
|
||
permissions: | ||
contents: read | ||
|
||
jobs: | ||
actionlint: | ||
runs-on: ubuntu-latest | ||
steps: | ||
- name: "Checkout" | ||
uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2 | ||
with: | ||
fetch-depth: 0 | ||
|
||
- name: "Run png-lint.sh to check excalidraw exported images" | ||
run: | | ||
tools/png-lint.sh |
This file contains 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
This file contains 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,15 @@ | ||
#!/bin/bash | ||
|
||
# Ensure that *.excalidraw.png files have the excalidraw metadata | ||
# embedded in them. This ensures they can be loaded back into | ||
# the tool and edited in the future. | ||
|
||
for file in $(find . -iname '*.excalidraw.png'); do | ||
if git check-ignore -q "$file"; then | ||
continue | ||
fi | ||
if ! grep -q "excalidraw+json" "$file"; then | ||
echo "$file was not exported from excalidraw with 'Embed Scene' enabled." | ||
exit 1 | ||
fi | ||
done |