Skip to content
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

Docsy as an NPM package: publish package, adjust dev deps, and document choices #2172

Open
2 tasks
chalin opened this issue Jan 14, 2025 · 0 comments
Open
2 tasks
Labels
CI/infra CI & infrastructure
Milestone

Comments

@chalin
Copy link
Collaborator

chalin commented Jan 14, 2025

We've faced issues with use of Docsy as an NPM dependency because we currently only support github package specifiers of the form github:google/docsy#semver:0.6.0. When performing an install (be it install or ci), NPM will always "dev" build the Docsy github packages (as I mention in #2171 (comment)), and hence fetch all of Docsy's dev and peer dependencies. This isn't a bug, it is a consequence of how NPM works and should be documented.

As we upgraded Kubernetes.io we faced a problem because hugo-extended (a dev dependency) couldn't be fully installed. Thankfully, @SayakMukhopadhyay identified the problem and proposed a solution: which is to include gcompat in the Docker image build (cf. kubernetes/website#49416 (comment)).

Related:

@chalin chalin added the CI/infra CI & infrastructure label Jan 14, 2025
@chalin chalin added this to the 25Q1 milestone Jan 14, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
CI/infra CI & infrastructure
Projects
None yet
Development

No branches or pull requests

1 participant