Skip to content

Add tips to generate docs from Mac OS without the noise output #1736

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 3 commits into
base: main
Choose a base branch
from

Conversation

benoittgt
Copy link
Contributor

@benoittgt benoittgt commented Jul 1, 2025

Addressing @TerryHowe feedback. #1729 (comment)

Generating doc using from Mac OS modify all ~/.config path with one in Application preferences folder. With the Docker command path are preserved.

benoittgt added 2 commits July 1, 2025 15:57
Because of where preferences are stored

Signed-off-by: Benoit Tigeot <[email protected]>
Signed-off-by: Benoit Tigeot <[email protected]>
@benoittgt benoittgt force-pushed the add-information-about-macos branch from dcd45e5 to 467015c Compare July 1, 2025 13:57
> export HOME='~' && \
> helm docs --type markdown --generate-headers --dir /output
> "
> ```
Copy link
Contributor

Choose a reason for hiding this comment

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

I'm getting this:

Executing busybox-1.37.0-r18.trigger
OK: 17 MiB in 29 packages
In order to verify checksum, openssl must first be installed.
Please install openssl or set VERIFY_CHECKSUM=false in your environment.
Failed to install helm
	For support, go to https://github.com/helm/helm.
% echo $?
1

Copy link
Contributor Author

Choose a reason for hiding this comment

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

That's weird. 🤔

I just tested locally with ubuntu instead of alphine and it's working well.

Processing triggers for libc-bin (2.39-0ubuntu8.4) ...
Processing triggers for ca-certificates (20240203) ...
Updating certificates in /etc/ssl/certs...
0 added, 0 removed; done.
Running hooks in /etc/ca-certificates/update.d...
done.
[WARNING] Could not find git. It is required for plugin installation.
Downloading https://get.helm.sh/helm-v3.18.3-linux-arm64.tar.gz
Verifying checksum... Done.
Preparing to install helm into /usr/local/bin
helm installed into /usr/local/bin/helm

And output is as we want.

Copy link
Contributor

Choose a reason for hiding this comment

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

Alpine worked when I installed openssl apk add --no-cache openssl curl bash && \

Copy link
Contributor

Choose a reason for hiding this comment

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

Ubuntu works fine too though

Signed-off-by: Benoit Tigeot <[email protected]>
@benoittgt benoittgt force-pushed the add-information-about-macos branch from 2b4f123 to d4ee02e Compare July 1, 2025 15:45
Copy link
Contributor

@TerryHowe TerryHowe left a comment

Choose a reason for hiding this comment

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

/lgtm

worked for me.

> export HOME='~' && \
> helm docs --type markdown --generate-headers --dir /output
> "
> ```
Copy link
Contributor

Choose a reason for hiding this comment

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

Alpine worked when I installed openssl apk add --no-cache openssl curl bash && \

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants