honeymoose
/
OpenSearch
mirror of https://github.com/honeymoose/OpenSearch.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

[DOCS] Update readme with release notes script 

Original commit: elastic/x-pack-elasticsearch@bdd387d6a9
This commit is contained in:
Lisa Cawley 2017-08-15 16:47:24 -07:00 committed by GitHub
parent fd76651d92
commit 670fc2fc06
1 changed files with 12 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
README.asciidoc
View File

@ -116,6 +116,18 @@ For example:
For information about building the X-Pack Reference, see the README in the x-pack repo.
To build a release notes page for the pull requests in this repository:
* You must have a personal access token called ~/.github_auth with "repo" scope. Use steps similar to "Vault Secret" to create this file.
* Use the dev-tools/xes-release-notes.pl script.
* Specify the version label for which you want the release notes.
* Redirect the output to a new local file.
For example:
[source, txt]
-----
./dev-tools/xes_release_notes.pl v5.5.2 > ~/tmp/5.5.2.asciidoc
-----
== Adding Images
When you include an image in the documentation, specify the path relative to the location of the asciidoc file. By convention, we put images in an `images` subdirectory.