address markdownlint issues

This commit is contained in:
Leif Singer 2023-11-10 16:24:48 +01:00
parent 030d67531f
commit 6fc6aabf6f
1 changed files with 12 additions and 14 deletions

View File

@ -1,12 +1,12 @@
## Release Post Generator CLI tool
# 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.woo.com.
Posts generated via the tool will be draft posted to <https://developer.woo.com>.
You can also generate an HTML representation of the post if you
don't have access to a WordPress.com auth token.
### Setup
## Setup
1. Make sure `pnpm i` has been run in the monorepo.
2. Make sure you have added a `.env` file with the env variables set. WCCOM_TOKEN is optional if you're using `--outputOnly`, but
@ -15,33 +15,31 @@ don't have access to a WordPress.com auth token.
4. Run the tool via the npm script, e.g. `pnpm run release-post release "6.8.0" --outputOnly`
5. For more help on individual options, run the help `pnpm run release-post <command> --help`. e.g. `pnpm run release-post rc --help`
### Publishing Draft Posts
## Publishing Draft Posts
This tool will publish draft posts to `https://developer.woo.com` for you if you omit the `--outputOnly` flag. There is some minimal first time setup for this though:
1. Create an app on WordPress.com [here](https://developer.wordpress.com/apps/).
2. 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"
- 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"
3. Once your app is created you can go back to the
app list and click "manage app".
4. Take note of the `client secret` and the `client id`.
5. In your `.env` file add the client secret to the `WPCOM_OAUTH_CLIENT_SECRET` variable and the client id to the `WPCOM_OAUTH_CLIENT_ID` variable.
### Generating Just a Contributors List
## 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
## Advanced
If you can't run anything on your localhost port 3000 you may want to override the redirect uri for oauth.