Skip to content

ci: chck changed files total size#721

Merged
f-hollow merged 1 commit into
espressif:mainfrom
f-hollow:ci/check_changed_files_total_size
May 9, 2026
Merged

ci: chck changed files total size#721
f-hollow merged 1 commit into
espressif:mainfrom
f-hollow:ci/check_changed_files_total_size

Conversation

@f-hollow
Copy link
Copy Markdown
Collaborator

@f-hollow f-hollow commented May 9, 2026

📝 Description

On a couple of occasions, the files committed to the repo were unreasonably large.

This PR adds a check to make sure that the total size of committed files does not exceed 500 KB.

If certain content exceeds 500 KB for a good reason, we can still merge it, but this check will help us take an informed decision.

Publish date

Expected publish date: YYYY-MM-DD

Review process

  • Initiate technical review
    • This item is N/A
    • Add subject matter experts (your team members, experts in the field)
  • Once tech review mostly done, initiate editorial review
    • Add technical editors (@f-hollow, @FBEZ, and/or @pedrominatel)

Checks

  • Article folder and file names:
    • Folder path is content/blog/YYYY/MM/my-new-article (articles only)
    • Folder and file names have no underscores, spaces, or uppercase letters (My new_article)
  • New article's YAML frontmatter:
    • Title updated
    • Date matches the format date: 20YY-MM-DD
    • Summary updated
    • Authors added (see Add youself as an author)
    • Tags added
  • Updated article's YAML frontmatter:
    • This item is N/A
    • If article folder is moved or renamed, the field aliases: with a new URL slug is added
    • Date of update is added lastmode: 20YY-MM-DD
  • Article media files:
    • All images are in .WebP format (see Use WebP for raster images)
    • Images are compressed within 100-300 KB, with a hard limit of ≤ 500 kB
    • Where possible, Hugo shortcodes are used instead of raw HTML for content types unsupported by markdown (see Use additional content types)
  • Links in articles
    • Make sure all links are valid
    • No links to Google docs present
    • Use a specific ESP-IDF version in links (avoid stable, hard no for latest)
  • Git history
    • Commits are clean and squashed to the minimum necessary
    • Commit messages follow Conventional Commits format
    • Your feature branch is rebased on main

🔗 Related

🧪 Testing (Hugo)

@f-hollow f-hollow force-pushed the ci/check_changed_files_total_size branch from 5bdfaea to 454ef3e Compare May 9, 2026 11:33
@f-hollow f-hollow force-pushed the ci/check_changed_files_total_size branch from 454ef3e to 8495047 Compare May 9, 2026 11:36
@f-hollow f-hollow merged commit e45f8a1 into espressif:main May 9, 2026
2 checks passed
@f-hollow f-hollow deleted the ci/check_changed_files_total_size branch May 9, 2026 11:40
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant