|
||
---|---|---|
.. | ||
commands/release-post | ||
lib | ||
templates | ||
.env.sample | ||
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 wc.com auth token.
Setup
- Make sure
pnpm i
has been run in the monorepo. - Make sure you have added a
.env
file with the env variables set. WCCOM_TOKEN is optional if you're using--outputOnly
, but theGITHUB_ACCESS_TOKEN
is required. If you need help generating a token see the docs. To silence all CLI output, setLOGGER_LEVEL
to"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 run release-post -- "6.8.0" --outputOnly
- For more help on individual options, run the help
pnpm run release-post -- --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 secret
and theclient id
. - In your
.env
file add the client secret to theWPCOM_OAUTH_CLIENT_SECRET
variable and the client id to theWPCOM_OAUTH_CLIENT_ID
variable.
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 run 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_URI
variable 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