Skip to content

Commit d0baaf2

Browse files
committed
adding release checklist steps
1 parent c2c44b0 commit d0baaf2

File tree

1 file changed

+16
-4
lines changed

1 file changed

+16
-4
lines changed

README.md

Lines changed: 16 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -10,13 +10,25 @@ provides a few new features:
1010
To try this out locally, check out the [ml-gradle example project](https://github.com/marklogic-community/ml-gradle/tree/dev/examples/unit-test-project).
1111
You can use that project's build.gradle file as an example of how to use marklogic-unit-test in your own project.
1212

13-
## Publishing
13+
## Releasing
14+
15+
To do a release:
16+
17+
1. Increment the `version` property in `{PROJECT}/gradle.properties`
18+
2. In `{PROJECT}/`, run `github_changelog_generator --token $your-github-token --future-release v1.0.0`
19+
20+
If running on Windows, you'll need to use different cache file paths, such as `--cache-file C:\tmp\github-changelog-http-cache --cache-log C:\tmp\github-changelog-logger.log`.
21+
22+
3. Commit the CHANGELOG.md
23+
4. Push changes to GitHub
24+
5. Do a PR to bring changes from the develop branch onto master
25+
6. Follow steps at https://help.github.com/articles/creating-releases/.
26+
27+
### Publishing to bintray
1428

1529
To publish this project, you need to publish both marklogic-unit-test-modules and marklogic-unit-test-client.
1630

17-
1. In `{PROJECT}/gradle.properties`:
18-
- Increment the `version` property
19-
- Add these properties to your `myBintrayUser`, `myBintrayKey`
31+
1. In `{PROJECT}/gradle.properties`, add these properties `myBintrayUser`, `myBintrayKey`
2032
2. `cd marklogic-unit-test-client`
2133
3. `gradle bintrayUpload`
2234
4. `cd ../marklogic-unit-test-modules`

0 commit comments

Comments
 (0)