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

feature: add verdaccio docker example #178

Merged
merged 3 commits into from
Dec 26, 2023

Conversation

alecastro-nan
Copy link
Contributor

@alecastro-nan alecastro-nan commented Dec 6, 2023

What's this PR do?

Summary of changes in this PR or what it accomplishes.

@ulises-jeremias

This pull request introduces a comprehensive example demonstrating the usage of Verdaccio with Docker containers. Verdaccio is a lightweight, private npm registry that allows developers to set up a local registry for testing and managing packages before pushing changes to a remote registry (among other use cases).
This addition is particularly useful for developers working on component libraries or npm packages. This is instrumental in ensuring the stability and integrity of packages before they are shared with the broader development team or the public.

Summary by CodeRabbit

  • Documentation
    • Updated the README for Verdaccio Docker with instructions on setting up a local package server, publishing, and unpublishing packages, along with usage recommendations.

Copy link

coderabbitai bot commented Dec 6, 2023

Walkthrough

The update involves a README.md file for the Verdaccio Docker example, detailing the setup and usage of Verdaccio with Docker for managing local packages. It provides instructions for initializing the server, publishing and unpublishing packages, and offers best practice tips. The changes seem to enhance documentation for better user guidance.

Changes

File Path Change Summary
examples/verdaccio-docker/README.md Updated instructions for setting up Verdaccio with Docker, including server setup, package management, and usage tips.

🐇✨
To the code that sails in the Docker sea,
Verdaccio's guide now clearer be.
With tweaks and tips so deftly spun,
A rabbit cheers for the job well done. 🎉🚀
🐇✨

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on X ?


Tips

Chat with CodeRabbit Bot (@coderabbitai)

  • You can reply to a review comment made by CodeRabbit.
  • You can tag CodeRabbit on specific lines of code or files in the PR by tagging @coderabbitai in a comment.
  • You can tag @coderabbitai in a PR comment and ask one-off questions about the PR and the codebase. Use quoted replies to pass the context for follow-up questions.

CodeRabbit Commands (invoked as PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger a review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • The JSON schema for the configuration file is available here.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/coderabbit-overrides.v2.json

Copy link
Member

@ulises-jeremias ulises-jeremias left a comment

Choose a reason for hiding this comment

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

@alecastro-nan great example! thank you! just some things before merging!

  • Rename the file docker-compose.yaml to compose.yml to match the new standard
  • Avoid creating a local directory for the volume to /verdaccio/storage. You can remove the driver: local from the module declaration and then just do verdaccio:/verdaccio/storage
  • Fix the issues found by our CI in order to make it pass

@ulises-jeremias ulises-jeremias merged commit ce056ae into nanlabs:main Dec 26, 2023
5 of 7 checks passed
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