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

tools: Update README.node_modules #20627

Merged
merged 2 commits into from
Jun 24, 2024

Conversation

martinpitt
Copy link
Member

  • Clean up unnecessarily complicated grammar/language
  • Fix some outright wrong statements like "Cockpit does not use npm packages code at runtime" -- we very clearly do (React/PF).
  • npm-install.yml is no more; replace with description of reposchutz.
  • node-cache.git is shared between all org projects
  • Setting up a new one from scratch only applies to forks or other orgs. Otherwise the key deployment is driven by a bots script.

Preview: https://github.com/martinpitt/cockpit/blob/node-docs/tools/README.node_modules.md

@martinpitt martinpitt added the no-test For doc/workflow changes, or experiments which don't need a full CI run, label Jun 20, 2024
@martinpitt
Copy link
Member Author

@allisonkarlitskaya gentle review ping?

Copy link
Member

@allisonkarlitskaya allisonkarlitskaya left a comment

Choose a reason for hiding this comment

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

Looks good, but maybe a minor tweak?

when building straight from a tarball it is also not necessary to have Node.js
installed.
Cockpit does not use npm or Node.js at runtime. When building/installing from
a release tarball it is also not necessary to have Node.js installed.
Copy link
Member

Choose a reason for hiding this comment

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

Maybe you want to press the point that we do use the modules at runtime, though?

Copy link
Member Author

Choose a reason for hiding this comment

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

Hmm, that's what the "and for runtime JavaScript libraries." in the previous paragraph was about. I changed this whole section again, hopefully more clear now?

- Clean up unnecessarily complicated grammar/language
- Fix some outright wrong statements like "Cockpit does not use npm
  packages code at runtime" -- we very clearly do (React/PF).
- `npm-install.yml` is no more; replace with description of reposchutz.
- node-cache.git is shared between all org projects
- Setting up a new one from scratch only applies to forks or other orgs.
  Otherwise the key deployment is driven by a bots script.
So that viewing in GitHub works as expected.
Copy link
Member

@allisonkarlitskaya allisonkarlitskaya left a comment

Choose a reason for hiding this comment

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

This is substantially more explicit, thanks!

@allisonkarlitskaya allisonkarlitskaya merged commit 613a49d into cockpit-project:main Jun 24, 2024
30 checks passed
@martinpitt martinpitt deleted the node-docs branch June 24, 2024 11:36
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
no-test For doc/workflow changes, or experiments which don't need a full CI run,
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants