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 wp-now documentation #251

Merged
merged 7 commits into from
May 22, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 22 additions & 0 deletions packages/wp-now/PUBLISHING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
# Publishing

The `wp-now` package is part of a larger [monorepo](https://github.com/WordPress/playground-tools), sharing its space with other sibling packages.

To publish the `wp-now` package to [npm](https://www.npmjs.com/package/@wp-now/wp-now), you must first understand the automated release process facilitated by lerna.

> [!TIP]
> For more information on Lerna and other tools used in Playground, check out the [Architecture overview](https://wordpress.github.io/wordpress-playground/architecture/index) chapter over on Playground's comprehensive documentation site.

This process includes automatically incrementing the version number, creating a new tag, and publishing all modified packages to npm simultaneously. Notably, all published packages **share the same version number**.

Each package identifies a distinct organization in its `package.json` file.

To publish the `wp-now` package, you need access to the `@wp-now` npm organization.

To initiate the publishing process for `wp-now`, execute the following commands:

```bash
npm login # this is required only once and it will store the credentials in ~/.npmrc file.
npm run build
npm run release:wp-now
```
Loading
Loading