@powerhousedao/academy 2.5.0-dev.10 → 2.5.0-dev.11

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.
package/CHANGELOG.md CHANGED
@@ -1,3 +1,13 @@
1
+ ## 2.5.0-dev.11 (2025-06-07)
2
+
3
+ ### 🚀 Features
4
+
5
+ - **connect:** updated diff-analyzer processor ([ce5d1219f](https://github.com/powerhouse-inc/powerhouse/commit/ce5d1219f))
6
+
7
+ ### ❤️ Thank You
8
+
9
+ - acaldas
10
+
1
11
  ## 2.5.0-dev.10 (2025-06-06)
2
12
 
3
13
  ### 🚀 Features
@@ -202,15 +202,79 @@ If you're publishing a package under a scope (like @your-org/my-package), you mi
202
202
  }
203
203
  ```
204
204
 
205
- For the actual publishing step, run the following command to publish your project to the npm registry:
205
+ ### 2.1 Versioning, Tagging, and Publishing Your Package
206
+
207
+ Before publishing, it's crucial to version your package correctly and tag the release in your Git repository. This helps track changes and allows users to depend on specific versions.
208
+
209
+ **1. Versioning with PNPM**
210
+
211
+ Use the `pnpm version` command to update your package version according to semantic versioning rules (`patch` for bugfixes, `minor` for new features, `major` for breaking changes). This command will:
212
+ - Update the `version` in your `package.json`.
213
+ - Create a Git commit for the version change.
214
+ - Create a Git tag for the new version (e.g., `v1.0.1`).
215
+
216
+ ```bash
217
+ # For a patch release (e.g., from 1.0.0 to 1.0.1)
218
+ pnpm version patch
219
+
220
+ # For a minor release (e.g., from 1.0.1 to 1.1.0)
221
+ pnpm version minor
222
+
223
+ # For a major release (e.g., from 1.1.0 to 2.0.0)
224
+ pnpm version major
225
+ ```
226
+ Take note of the new version tag created (e.g., `v1.0.1`), as you'll need it in the next step.
227
+
228
+ **2. Pushing Changes to Git**
229
+
230
+ Next, push your commits and the new version tag to your remote Git repository:
231
+
232
+ ```bash
233
+ # Push your current branch (e.g., main or master)
234
+ # Replace 'main' with your default branch name if different
235
+ git push origin main
236
+
237
+ # Push the specific tag created by pnpm version
238
+ # Replace vX.Y.Z with the actual tag name (e.g., v1.0.1)
239
+ git push origin vX.Y.Z
240
+ ```
241
+ The specific tag name (e.g., `v1.0.1`) is usually output by the `pnpm version` command. Pushing the specific tag is recommended to avoid unintentionally pushing other local tags.
242
+
243
+ Alternatively, to push all new local tags (use with caution):
244
+ ```bash
245
+ # git push --tags
246
+ ```
247
+
248
+ **3. Understanding Git Tags vs. NPM Distributor Tags**
249
+
250
+ It's important to distinguish between Git tags and NPM distributor tags (dist-tags):
251
+
252
+ - **Git Tags**: These are markers in your Git repository's history. They are primarily for developers to pinpoint specific release versions in the codebase (e.g., `v1.0.0`, `v1.0.1`). The `pnpm version` command creates these.
253
+ - **NPM Distributor Tags (dist-tags)**: These are labels used by the NPM registry to point to specific published versions of your package. Common NPM tags include:
254
+ - `latest`: This is the default tag. When someone runs `pnpm install my-package`, NPM installs the version tagged as `latest`.
255
+ - `beta`, `next`, `alpha`: Often used for pre-release versions.
256
+ When you publish a package without specifying an NPM tag, it usually gets the `latest` tag by default.
257
+
258
+ **4. Publishing to NPM**
259
+
260
+ Now you are ready to publish your package to the NPM registry. Ensure you are logged into NPM (the `npm login` command shown in previous steps should be used, or `pnpm login` which is an alias).
261
+
262
+ ```bash
263
+ pnpm publish
264
+ ```
265
+ This command will publish the version of your package that is currently specified in your `package.json`. By default, this will also set the `latest` NPM dist-tag for this version.
266
+
267
+ If your package is scoped (e.g., `@your-org/my-package`) and intended to be public, ensure your `package.json` includes the `publishConfig` shown earlier. If this is not set in `package.json` (and your package is scoped), you might need to use:
206
268
  ```bash
207
- npm publish
269
+ pnpm publish --access public
208
270
  ```
209
271
 
210
- Optionally, if you are publishing a scoped package and you want it public, run:
272
+ You can also publish a version to a specific NPM dist-tag. For example, to publish a beta version:
211
273
  ```bash
212
- npm publish --access public
274
+ # Ensure your package.json version reflects the beta (e.g., 1.1.0-beta.0)
275
+ pnpm publish --tag beta
213
276
  ```
277
+ This is useful for testing releases before making them `latest`.
214
278
 
215
279
  Now let's verify that the package(s) get published in the package repository, next to pre-existing packages that you might have been publishing before.
216
280
 
@@ -43,7 +43,7 @@ import { Tabs, TabItem } from '@theme/Tabs';
43
43
  - **Error Message Example:** "Invalid PHID format. Please check the document ID, branch, or scope."
44
44
  </details>
45
45
 
46
- The following is a the UI component for the PHID field and scalar in a storybook.
46
+ The following is the UI component for the PHID field and scalar in a storybook.
47
47
  We use Storybook as our component development environment.
48
48
  It allows us to build and test UI components in isolation, making it easier to develop, test, and document reusable components.
49
49
  In our stories you'll find first find a basic UI implementation example of the component, followed by the component's properties, events, and validation options.
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@powerhousedao/academy",
3
- "version": "2.5.0-dev.10",
3
+ "version": "2.5.0-dev.11",
4
4
  "homepage": "https://powerhouse.academy",
5
5
  "repository": {
6
6
  "type": "git",