From a49f5d7582dbb039bc802ab8c98989f4c155a05e Mon Sep 17 00:00:00 2001 From: Elizabeth Engelman Date: Wed, 8 May 2019 12:49:56 -0500 Subject: [PATCH] Add repository maintenance documentation --- documentation/{ => diagrams}/vdb-overview.png | Bin documentation/repository-maintenance.md | 27 ++++++++++++++++++ 2 files changed, 27 insertions(+) rename documentation/{ => diagrams}/vdb-overview.png (100%) create mode 100644 documentation/repository-maintenance.md diff --git a/documentation/vdb-overview.png b/documentation/diagrams/vdb-overview.png similarity index 100% rename from documentation/vdb-overview.png rename to documentation/diagrams/vdb-overview.png diff --git a/documentation/repository-maintenance.md b/documentation/repository-maintenance.md new file mode 100644 index 00000000..317ad92f --- /dev/null +++ b/documentation/repository-maintenance.md @@ -0,0 +1,27 @@ +# Repository Maintenance + +## Diagrams +- Diagrams were created with [draw.io](draw.io). +- To update a diagram: + 1. Go to [draw.io](draw.io). + 1. Click on *File > Open from* and choose the location of the diagram you want to update. + 1. Once open in draw.io, you may update it. + 1. Export the diagram to this repository's directory and add commit it. + + +## Generating the Changelog +We use [github-changelog-generator](https://github.com/github-changelog-generator/github-changelog-generator) to +generate release Changelogs. To be consistent with previous Changelogs, the following flags should be passed to the +command: + +``` +--user vulcanize +--project vulcanizedb +--token {YOUR_GITHUB_TOKEN} +--no-issues +--usernames-as-github-logins +--since-tag {PREVIOUS_RELEASE_TAG} +``` + +More information on why your github token is needed, and how to generate it here:https://github +.com/github-changelog-generator/github-changelog-generator#github-token \ No newline at end of file