Skip to content

Conversation

@cameel
Copy link
Collaborator

@cameel cameel commented Oct 16, 2025

Follow-up to #16256.

During the prerelease we discovered that create_source_tarball.sh packages nlohmann-json docs as a part of our source. And it includes a bunch of unnecessary things, especially big images and rendered versions of the docs. For example:

Excluding doc/ and docs/ from these submodules shaves off almost half of the size of the source tarball (12.3 MB -> 7.3 MB).

These things are essentially dead weight as I would not expect anyone to look for them in our archive (they'd more likely go the source repo or to their docs webpage) and they do not the affect compiler build.

@cameel cameel self-assigned this Oct 16, 2025
@cameel cameel force-pushed the exclude-docs-from-source-tarball branch from 4042b32 to e69a192 Compare October 16, 2025 17:29
nikola-matic
nikola-matic previously approved these changes Oct 16, 2025
clonker
clonker previously approved these changes Oct 20, 2025
@cameel cameel force-pushed the exclude-docs-from-source-tarball branch from e69a192 to 8fd05e2 Compare October 20, 2025 11:16
@cameel cameel enabled auto-merge October 20, 2025 11:16
@cameel cameel disabled auto-merge October 20, 2025 11:18
@cameel
Copy link
Collaborator Author

cameel commented Oct 20, 2025

I was about to merge this, but decided to take one last look at c_source_tarball. For some reason it still produces a tarball that includes the docs, even though locally the docs were being excluded back when I created and tested the PR. Will have to investigate. For now reverting back to draft.

@cameel cameel marked this pull request as draft October 20, 2025 11:19
@github-actions github-actions bot added the stale The issue/PR was marked as stale because it has been open for too long. label Nov 3, 2025
@cameel cameel removed the stale The issue/PR was marked as stale because it has been open for too long. label Nov 8, 2025
@github-actions github-actions bot added the stale The issue/PR was marked as stale because it has been open for too long. label Nov 22, 2025
@cameel cameel removed the stale The issue/PR was marked as stale because it has been open for too long. label Nov 25, 2025
@cameel cameel force-pushed the exclude-docs-from-source-tarball branch from 8fd05e2 to bd650bb Compare December 2, 2025 22:28
@argotorg argotorg deleted a comment from github-actions bot Dec 2, 2025
@argotorg argotorg deleted a comment from github-actions bot Dec 2, 2025
@cameel cameel dismissed stale reviews from clonker and nikola-matic via 35b0ee1 December 2, 2025 22:46
@cameel cameel force-pushed the exclude-docs-from-source-tarball branch from f21277e to eda0aea Compare December 2, 2025 23:10
@cameel
Copy link
Collaborator Author

cameel commented Dec 2, 2025

I found the issue. When executed on CircleCI, the shell apparently takes the {doc,docs} bit literally when that's included in git submodule foreach. It's supposed to expand into <prefix>/doc <prefix>/docs. On my machine it works. I suspect that on CircleCI it's using a different shell for some reason (even though the script itself still runs in Bash).

I replaced it with two commands so now everything should be fine in CI as well.

@cameel cameel marked this pull request as ready for review December 2, 2025 23:14
@cameel cameel requested a review from matheusaaguiar December 2, 2025 23:14
@cameel cameel added this to the 0.8.31 milestone Dec 2, 2025
@cameel cameel force-pushed the exclude-docs-from-source-tarball branch from eda0aea to 3e97db9 Compare December 2, 2025 23:17
Copy link
Collaborator

@matheusaaguiar matheusaaguiar left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Confirmed that the size of the tarball is reduced and the docs of dependencies are not present.

@cameel cameel force-pushed the exclude-docs-from-source-tarball branch from 3e97db9 to 809c719 Compare December 3, 2025 00:05
@cameel cameel merged commit bdc1116 into develop Dec 3, 2025
81 checks passed
@cameel cameel deleted the exclude-docs-from-source-tarball branch December 3, 2025 01:04
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants