Updated Release Process (markdown)

Ilya Dmitrichenko
2016-09-28 14:35:28 +01:00
parent 61540eb1de
commit 442e0f0c26
+51 -1
@@ -148,7 +148,7 @@ Merge the release branch to master.
Go to [https://checkpoint-api.weave.works/admin](https://checkpoint-api.weave.works/admin) and fill in the details of the release for **both for the scope-app and scope-probe products** so that users can be automatically informed of a new version being available.
## Publish documentation
## Publish release documentation
1. Install wordepress: `go get -u github.com/weaveworks/wordepress/cmd/wordepress`
2. Obtain a Wordpress application password:
@@ -160,3 +160,53 @@ Go to [https://checkpoint-api.weave.works/admin](https://checkpoint-api.weave.wo
* If everything went well, pubslish without dry-run: `wordepress publish --url https://www.weave.works --user yourwordpressuser --password 'your wordpress application password' --product scope --tag latest --version 0.1.0 releases/v0.1.0/site`
You're done. Congratulations.
## Updating release documentation
If you merged a documentation change to master, you can update the published docs with wordepress (see above for setup instructions).
First, check commit log to confirm that master doesn't have documentation that doesn't relate to the release:
```
git fetch --tags
git log -p latest_release..@ site/
```
If all looks good, do this:
```
wordepress publish --dry-run --url https://www.weave.works --user 'errordeveloper' --password 'secret' --product scope --tag latest --version 0.17.1 site
```
The output should look similar to this:
```
2016/09/28 14:28:35 Loading 6 markdown files from site
2016/09/28 14:28:36 Loaded document scope-latest-plugins
2016/09/28 14:28:36 Loaded document scope-latest-introducing
2016/09/28 14:28:36 Loaded document scope-latest-installing
2016/09/28 14:28:36 Loaded document scope-latest-how-it-works
2016/09/28 14:28:36 Loaded document scope-latest-features
2016/09/28 14:28:36 Loaded document scope-latest-building
2016/09/28 14:28:36 Would skip document: scope-latest-building
2016/09/28 14:28:36 Would skip document: scope-latest-features
2016/09/28 14:28:36 Would skip document: scope-latest-how-it-works
2016/09/28 14:28:36 Would update document: scope-latest-installing
2016/09/28 14:28:36 Would skip document: scope-latest-introducing
2016/09/28 14:28:36 Would skip document: scope-latest-plugins
2016/09/28 14:28:36 Would skip image: e9fc2b7bec70c15acf1e954af137bae149bd0ffe.png
2016/09/28 14:28:36 Would skip image: 1f6124fdbc669622d6b498572e44894880e78e5a.png
2016/09/28 14:28:36 Would skip image: cd819a0671f32847e35a23e21420b13766d2e8fa.png
2016/09/28 14:28:36 Would skip image: 30e8bef5b3470abc9c64b11a63d864a74d1fecdd.png
2016/09/28 14:28:36 Would skip image: a2aaa36fe950f3fbfa663c9272e6dc523cabb2f3.png
2016/09/28 14:28:36 Would skip image: 67ef4e34ecf59431a1a787cafe1f56cc225e8d69.png
2016/09/28 14:28:36 Would skip image: 6e5464122a73510c718b8242ed4be58402edc95b.png
2016/09/28 14:28:36 Would skip image: 12feb8d1235160296f11ddb22edfaaa34a9bf0eb.png
2016/09/28 14:28:36 Would skip image: 29238657a28fa87c6588fa4207e6cecdd16840f0.png
```
In the above case we can see that the only file that will updates is this:
```
2016/09/28 14:28:36 Would update document: scope-latest-installing
```
Which is good, so no run without `--dry-run`:
```
wordepress publish --dry-run --url https://www.weave.works --user 'errordeveloper' --password 'secret' --product scope --tag latest --version 0.17.1 site
```