Skip to content

fix: omit documentation images from source releases - #3328

Merged
imbajin merged 7 commits into
apache:masterfrom
hugegraph:fix/release-source-images
Oct 13, 2026
Merged

imbajin merged 7 commits into
apache:masterfrom
hugegraph:fix/release-source-images

Conversation

@imbajin

@imbajin imbajin commented Oct 13, 2026 •

Copy link
Copy Markdown
Member

Organization counterpart: hugegraph#305.

Purpose of the PR

Server source releases include two documentation diagrams that are unnecessary for rebuilding the product and trigger large-file/image provenance review notes.

Main Changes

  • Exclude docs/images/ through the existing .gitattributes.
  • Move the Helm architecture diagram unchanged into .github/images/ and update the chart README with a relative image link. The entire .github/ directory is already excluded from source archives, so Helm no longer needs its own images/ directory.
  • Keep native git archive packaging and product resources unchanged; no new script.

Verifying these changes

Streamed git archive file-list comparison: exactly the two documentation PNGs are omitted; all other archived paths remain. The moved Helm image has the same Git blob, and its README reference matches the new location. git diff --check passed. No SVN artifacts were downloaded/extracted/run locally and no archive was saved to disk. CI is running.

Does this PR potentially affect the following parts?

  • Other affects: source release contents and Helm README image location
  • Dependencies
  • Modify configurations
  • The public API
  • Nope

Documentation Status

  • Doc - Done: helm/hugegraph/README.md image link updated.
  • Doc - TODO
  • Doc - No Need

Conceptual overview

Conceptual overview: exclude documentation artwork from source archives; retain build/runtime contents. Server changes only its image/archive paths. This diagram is not runtime or release-validation evidence.

ASF Server, Toolchain and validator source packaging overview

Exclude Server documentation and Helm diagrams from git archives.
Keep repository documentation and product resources unchanged.
Reuse export-ignore without changing release scripts.
@codecov

codecov Bot commented Oct 13, 2026 •

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 52.83%. Comparing base (2691ae5) to head (d007ec2).
⚠️ Report is 2 commits behind head on master.

Additional details and impacted files
@@             Coverage Diff              @@
##             master    #3328      +/-   ##
============================================
+ Coverage     52.67%   52.83%   +0.16%     
- Complexity     2070     2072       +2     
============================================
  Files           770      770              
  Lines         67694    67937     +243     
  Branches       9172     9210      +38     
============================================
+ Hits          35655    35892     +237     
+ Misses        28489    28487       -2     
- Partials       3550     3558       +8     

☔ View full report in Codecov by Harness.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@imbajin imbajin changed the title fix: exclude documentation images from source releases fix: omit documentation images from source releases Oct 13, 2026
Comment thread .gitattributes
Pengzna
Pengzna previously approved these changes Oct 13, 2026
- pin lifecycle and Helm images to Apache source blobs
- keep excluded image assets out of release archives
- preserve the archive path set and original image bytes
MrJs133
MrJs133 previously approved these changes Oct 13, 2026
@imbajin
imbajin merged commit 8639720 into apache:master Oct 13, 2026
37 checks passed
@imbajin
imbajin deleted the fix/release-source-images branch October 13, 2026 20:43
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.

3 participants