@ricardohsmello/mongodb-cli-lab 1.0.0 → 1.0.1

package/.github/workflows/publish.yml

@@ -0,0 +1,35 @@
+name: Publish Package
+
+on:
+  push:
+    tags:
+      - "v*"
+  workflow_dispatch:
+
+jobs:
+  publish:
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+      id-token: write
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+
+      - name: Setup Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: 20
+          registry-url: https://registry.npmjs.org
+
+      - name: Install dependencies
+        run: npm install
+
+      - name: Verify package contents
+        run: npm pack --dry-run
+
+      - name: Publish to npm
+        run: npm publish --access public
+        env:
+          NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}

package/README.md

@@ -0,0 +1,47 @@
+# MongoDB CLI Lab
+
+`MongoDB CLI Lab` is an npm CLI for learning and testing MongoDB sharding in a local Docker environment.
+
+It helps you create a sharded cluster automatically so you can focus on understanding the workflow instead of setting everything up by hand.
+
+With the CLI, you can:
+
+- create a local MongoDB sharded cluster
+- choose the number of shards
+- choose the number of replica set members per shard
+- choose the MongoDB version
+- define the `mongos` port
+- create collections
+- enable sharding for collections
+- run simple experiments to understand shard distribution
+
+This project is intended for study, demos, and local experiments. It is a learning lab, not a production-ready solution.
+
+## Prerequisites
+
+Before running the CLI, you need:
+
+- Docker installed
+- Docker running
+
+## How to run
+
+1. Install the package:
+
+```bash
+npm i @ricardohsmello/mongodb-cli-lab
+```
+
+2. Run the CLI:
+
+```bash
+npx mongodb-cli-lab
+```
+
+The command opens an interactive flow where you can create the cluster, configure shards, and work with sharded collections.
+
+## Important
+
+This tool was built for educational purposes only.
+
+It should not be used in production as-is. Any production usage would require a proper technical review, operational hardening, and validation by whoever decides to adopt it.

package/RELEASING.md

@@ -0,0 +1,39 @@
+# Releasing
+
+This project publishes to npm automatically through GitHub Actions when a new Git tag is pushed.
+
+## Release flow
+
+1. Update the version in `package.json`:
+
+```bash
+npm version patch --no-git-tag-version
+```
+
+2. Commit the version change:
+
+```bash
+git add .
+git commit -m "release: v1.0.6"
+```
+
+3. Create the Git tag:
+
+```bash
+git tag v1.0.6
+```
+
+4. Push the branch and the tag:
+
+```bash
+git push origin main --tags
+```
+
+When the tag is pushed, GitHub Actions publishes the package to npm automatically.
+
+## Notes
+
+- The npm package manifest lives in the repository root.
+- The CLI entrypoint is `src/index.js`.
+- Replace `patch` with `minor` or `major` when needed.
+- The published package name is `@ricardohsmello/mongodb-cli-lab`.

package/package.json

@@ -1,9 +1,9 @@
 {
   "name": "@ricardohsmello/mongodb-cli-lab",
-  "version": "1.0.0",
+  "version": "1.0.1",
   "description": "CLI to create a local MongoDB sharded cluster using Docker",
   "bin": {
-    "mongodb-cli-lab": "./index.js"
+    "mongodb-cli-lab": "./src/index.js"
   },
   "type": "module",
   "dependencies": {