4fa2e3822c
* test bumping node to v18 * remove community contributor condition from review assignment * Add changefile(s) from automation for the following project(s): @woocommerce/tracks, @woocommerce/onboarding, @woocommerce/number, @woocommerce/notices, @woocommerce/navigation, @woocommerce/internal-js-tests, @woocommerce/extend-cart-checkout-block, @woocommerce/expression-evaluation, @woocommerce/explat, @woocommerce/experimental, @woocommerce/eslint-plugin, @woocommerce/dependency-extraction-webpack-plugin, @woocommerce/date, @woocommerce/data, @woocommerce/customer-effort-score, @woocommerce/currency, @woocommerce/csv-export, @woocommerce/create-woo-extension, @woocommerce/create-product-editor-block, @woocommerce/components, @woocommerce/api, @woocommerce/admin-e2e-tests, woocommerce-blocks, woocommerce-beta-tester, woocommerce, woo-ai * bump node to v20 * Add changefile(s) from automation for the following project(s): @woocommerce/tracks, @woocommerce/onboarding, @woocommerce/number, @woocommerce/notices, @woocommerce/navigation, @woocommerce/internal-js-tests, @woocommerce/extend-cart-checkout-block, @woocommerce/expression-evaluation, @woocommerce/explat, @woocommerce/experimental, @woocommerce/eslint-plugin, @woocommerce/dependency-extraction-webpack-plugin, @woocommerce/date, @woocommerce/data, @woocommerce/customer-effort-score, @woocommerce/currency, @woocommerce/csv-export, @woocommerce/create-woo-extension, @woocommerce/create-product-editor-block, @woocommerce/components, @woocommerce/api, @woocommerce/admin-e2e-tests, packages/php/remote-specs-validation, woocommerce-blocks, woocommerce-beta-tester, woocommerce, woo-ai * Add changefile(s) from automation for the following project(s): @woocommerce/tracks, @woocommerce/onboarding, @woocommerce/number, @woocommerce/notices, @woocommerce/navigation, @woocommerce/internal-js-tests, @woocommerce/extend-cart-checkout-block, @woocommerce/expression-evaluation, @woocommerce/explat, @woocommerce/experimental, @woocommerce/eslint-plugin, @woocommerce/dependency-extraction-webpack-plugin, @woocommerce/date, @woocommerce/data, @woocommerce/customer-effort-score, @woocommerce/currency, @woocommerce/csv-export, @woocommerce/create-woo-extension, @woocommerce/create-product-editor-block, @woocommerce/components, @woocommerce/api, @woocommerce/admin-e2e-tests, woocommerce-blocks, woocommerce-beta-tester, woocommerce, woo-ai * add blocks eslint-plugin-woocommerce to project workspace * add e2e-environment as a peer to e2e-utils * restore version on @woocommerce/api * update lock file * move e2e-environment to devDependencies * add undefined location check to admin js test --------- Co-authored-by: Ron Rennick <ronald.rennick@automattic.com> Co-authored-by: github-actions <github-actions@github.com> |
||
|---|---|---|
| .. | ||
| commands/release-post | ||
| lib | ||
| templates | ||
| .env.sample | ||
| .prettierignore | ||
| README.md | ||
| index.ts | ||
| package.json | ||
| program.ts | ||
| tsconfig.json | ||
README.md
Release Post Generator CLI tool
This is a cli tool designed to generate draft release posts for WooCommerce. Posts generated via the tool will be draft posted to https://developer.woocommerce.com.
You can also generate an HTML representation of the post if you don't have access to a WordPress.com auth token.
Setup
- Make sure
pnpm ihas been run in the monorepo. - Make sure you have added a
.envfile with the env variables set. WCCOM_TOKEN is optional if you're using--outputOnly, but theGITHUB_ACCESS_TOKENis required. If you need help generating a token see the docs. To silence all CLI output, setLOGGER_LEVELto"silent". - Note that the env file should live at the same path that you're running the command from.
- Run the tool via the npm script, e.g.
pnpm release-post release "6.8.0" --outputOnly - For more help on individual options, run the help
pnpm release-post <command> --help. e.g.pnpm release-post rc --help
Publishing Draft Posts
This tool will publish draft posts to https://developer.woocommerce.com for you if you omit the --outputOnly flag. There is some minimal first time setup for this though:
- Create an app on WordPress.com here.
- Recommended settings:
- Name can be anything
- Description can be left blank
- Website URL just put
http://localhost - Redirect URLs, by default you should add:
http://localhost:3000/oauth - JavaScript Origins put
http://localhost - Type - choose "Web"
- Once your app is created you can go back to the app list and click "manage app".
- Take note of the
client secretand theclient id. - In your
.envfile add the client secret to theWPCOM_OAUTH_CLIENT_SECRETvariable and the client id to theWPCOM_OAUTH_CLIENT_IDvariable.
Generating Just a Contributors List
If you don't have a final release yet you can generate an HTML contributors list that you can copy paste into a blank post.
To do that simply run pnpm release-post contributors "<currentVersion>" "<previousVersion>"
Advanced
If you can't run anything on your localhost port 3000 you may want to override the redirect uri for oauth.
Steps:
- Add your preferred redirect URI to the
WPCOM_OAUTH_REDIRECT_URIvariable in.env. e.g.http://localhost:4321/oauth - When creating your app on WordPress.com make sure the redirect URL you set matches the one set in
.env