Skip to content

Add a check for videos format in CI#10441

Merged
slax57 merged 4 commits intomasterfrom
ci-videos-format-check
Jan 10, 2025
Merged

Add a check for videos format in CI#10441
slax57 merged 4 commits intomasterfrom
ci-videos-format-check

Conversation

@djhi
Copy link
Contributor

@djhi djhi commented Jan 10, 2025

Problem

We had many issues in the past with incompatible video formats or codecs on video assets used in the documentation (e.g. not readable on Firefox or Ubuntu+Chrome)

We risk doing the same error in the future, as our screen capture tools seem to produce erroneous videos by default

Solution

Add a CI step to check the video asset files

How To Test

  • Create a video with a wrong format (use something like https://convertio.co/ to convert a video into HEVC format)
  • run the script: make check-documentation-videos-format
  • It should print a warning:
Invalid codec for ./docs/img/test/test.mp4
Convert it to avc1 with:
ffmpeg -i ./docs/img/test/test.mp4 -c:v libx264 -c:a copy ./docs/img/test/test_avc1.mp4
rm ./docs/img/test/test.mp4
mv ./docs/img/test/test_avc1.mp4 ./docs/img/test/test.mp4
make: *** [Makefile:180: check-documentation-videos-format] Error 1

Additional Checks

  • The PR targets master for a bugfix, or next for a feature

@slax57 slax57 added this to the 5.4.4 milestone Jan 10, 2025
@slax57 slax57 merged commit 3ff4df4 into master Jan 10, 2025
14 checks passed
@slax57 slax57 deleted the ci-videos-format-check branch January 10, 2025 11:22
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

RFR Ready For Review

Development

Successfully merging this pull request may close these issues.

2 participants