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

Update contributing doc to explain how to test CLI and controller images #1444

Open
cmwylie19 opened this issue Nov 19, 2024 · 1 comment
Open
Assignees

Comments

@cmwylie19
Copy link
Collaborator

cmwylie19 commented Nov 19, 2024

Describe what should be investigated or refactored

A new contributor who is working on a CLI command was confused as to how to run the new command. We need to update the contributing doc to show how to use npx ts-node src/cli.ts <command>

Also update the document to show how to use pepr:dev to use the latest controller code.

Explain how you could use npm pack to bring in a development cli to a new module.

The package.json had a lot of examples on how to run e2e, unit test, lint.

The pepr-excellent-examples has examples in the README.md on how to use npm pack to bring a development CLI into a Pepr Module.

@cmwylie19 cmwylie19 added this to the v0.40.0 milestone Nov 19, 2024
@cmwylie19 cmwylie19 changed the title Add how to test the CLI in the contributing doc Update contributing doc to explain how to test CLI and controller images Nov 19, 2024
@cmwylie19 cmwylie19 removed this from the v0.40.0 milestone Nov 19, 2024
@cmwylie19
Copy link
Collaborator Author

@soltysh expressed interest in working on this as he dives into Pepr. 🙏

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Status: 🆕 New
Development

No branches or pull requests

2 participants