Skip to content

[release-1.22] Disable urfave markdown/man docs generation#5701

Merged
brandond merged 1 commit intok3s-io:release-1.22from
brandond:cli_no_docs_release-1.22
Jun 15, 2022
Merged

[release-1.22] Disable urfave markdown/man docs generation#5701
brandond merged 1 commit intok3s-io:release-1.22from
brandond:cli_no_docs_release-1.22

Conversation

@brandond
Copy link
Copy Markdown
Member

Proposed Changes

Disable urfave markdown/man docs generation. We're not using either of these, so it's just bloat.

From urfave/cli#1383 :

This removes the resulting binary dependency on cpuguy83/md2man and
russross/blackfriday (and a few more packages imported by those),
which saves more than 400 KB (more than 300 KB
once stripped) from the resulting binary.

A/B comparison of builds without/with this commit:

k3s binary dist/artifacts/k3s size 66265088 is less than max acceptable size of 67108864 bytes (64 MiB)
k3s binary dist/artifacts/k3s size 65044480 is less than max acceptable size of 67108864 bytes (64 MiB)

This is a savings of 1192 Kb - just shy of 1MiB.

Types of Changes

size reduction

Verification

Check size of resulting K3s binary

Linked Issues

User-Facing Change

NONE

Further Comments

From urfave/cli#1383 :
> This removes the resulting binary dependency on cpuguy83/md2man and
> russross/blackfriday (and a few more packages imported by those),
> which saves more than 400 KB (more than 300 KB
> once stripped) from the resulting binary.

Signed-off-by: Brad Davidson <brad.davidson@rancher.com>
@brandond brandond requested a review from a team as a code owner June 14, 2022 21:44
@brandond brandond merged commit 952f068 into k3s-io:release-1.22 Jun 15, 2022
@brandond brandond deleted the cli_no_docs_release-1.22 branch June 6, 2024 21:12
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.

2 participants