adograb 0.1.0 → 0.1.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/README.md +86 -0
  2. package/package.json +1 -1
package/README.md CHANGED
@@ -103,6 +103,92 @@ Settings are stored using [`conf`](https://github.com/sindresorhus/conf) in the
103
103
 
104
104
  PATs are stored in the OS credential store — they are **not** in the config file.
105
105
 
106
+ ## Publish to npm
107
+
108
+ This package is published to [npmjs.com/package/adograb](https://www.npmjs.com/package/adograb).
109
+
110
+ Publishing is automated via GitHub Actions — push a version tag and it builds and publishes automatically.
111
+
112
+ ---
113
+
114
+ ### One-time setup (do this once)
115
+
116
+ **1. Create an npm access token**
117
+
118
+ - Go to [npmjs.com](https://www.npmjs.com) → log in → click your profile → **Access Tokens**
119
+ - Click **Generate New Token** → **Classic Token** → select type **Publish**
120
+ - Copy the token (starts with `npm_...`)
121
+
122
+ **2. Add the token to GitHub**
123
+
124
+ - Go to your GitHub repo → **Settings** → **Secrets and variables** → **Actions**
125
+ - Click **New repository secret**
126
+ - Name: `NPM_TOKEN`
127
+ - Value: paste the token from above
128
+ - Click **Add secret**
129
+
130
+ ---
131
+
132
+ ### Publishing a new version
133
+
134
+ **Step 1 — Make your code changes**
135
+
136
+ Do your changes, then commit them:
137
+ ```bash
138
+ git add .
139
+ git commit -m "your change description"
140
+ ```
141
+
142
+ **Step 2 — Bump the version**
143
+
144
+ Pick one depending on what changed:
145
+ ```bash
146
+ npm version patch # bug fix 0.1.0 → 0.1.1
147
+ npm version minor # new feature 0.1.0 → 0.2.0
148
+ npm version major # breaking change 0.1.0 → 1.0.0
149
+ ```
150
+ This automatically updates `package.json` and creates a git tag like `v0.1.1`.
151
+
152
+ **Step 3 — Push code and tag to GitHub**
153
+
154
+ ```bash
155
+ git push origin master --tags
156
+ ```
157
+
158
+ **Step 4 — Done**
159
+
160
+ GitHub Actions will automatically:
161
+ 1. Install dependencies
162
+ 2. Build the project
163
+ 3. Publish the new version to npm
164
+
165
+ You can watch it run under the **Actions** tab in your GitHub repo.
166
+
167
+ ---
168
+
169
+ ### Publish from local machine
170
+
171
+ If you want to publish directly from your machine without GitHub Actions:
172
+
173
+ **Step 1 — Commit your changes**
174
+ ```bash
175
+ git add .
176
+ git commit -m "your change description"
177
+ ```
178
+
179
+ **Step 2 — Bump the version** (this updates `package.json` automatically)
180
+ ```bash
181
+ npm version patch # bug fix 0.1.0 → 0.1.1
182
+ npm version minor # new feature 0.1.0 → 0.2.0
183
+ npm version major # breaking change 0.1.0 → 1.0.0
184
+ ```
185
+
186
+ **Step 3 — Build and publish**
187
+ ```bash
188
+ npm run build
189
+ npm publish
190
+ ```
191
+
106
192
  ## License
107
193
 
108
194
  MIT
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "adograb",
3
- "version": "0.1.0",
3
+ "version": "0.1.2",
4
4
  "description": "Browse and clone Azure DevOps repositories from the terminal.",
5
5
  "type": "module",
6
6
  "bin": {