From 93df9755750add2298305f2a320b9e841ce45ee0 Mon Sep 17 00:00:00 2001 From: ssube Date: Sun, 30 Jun 2019 20:49:12 -0500 Subject: [PATCH] docs: fix commit links in changelog for v0.5.0 --- CHANGELOG.md | 44 ++++++++++++++++++++++---------------------- docs/workflow.md | 16 ++++++++++++++-- 2 files changed, 36 insertions(+), 24 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 4712bd7..34ac00e 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -7,36 +7,36 @@ All notable changes to this project will be documented in this file. See [standa ### Bug Fixes -* make -v an alias for --version 5f5b993 -* **build:** actually fix mdl config 675b200 -* **build:** add rpt2 cache to cache rather than artifacts 0996390 -* **build:** artifact all output 9eacea6 -* **build:** attempt to fix mdl config 24ebc9e -* **build:** clean up output directory between builds 30ea7d6 -* **build:** move sinon to vendor chunk d02b223 -* **build:** run generic build target c41d9d0 -* **build:** split index into its own chunk 8351fff -* **container:** set up as cli tool within container ef2a9c9 -* **rules/tsconfig:** correctly enforce lib/target for esnext 62d58fe +* make -v an alias for --version ([5f5b993](https://github.com/ssube/salty-dog/commit/5f5b993)) +* **build:** actually fix mdl config ([675b200](https://github.com/ssube/salty-dog/commit/675b200)) +* **build:** add rpt2 cache to cache rather than artifacts ([0996390](https://github.com/ssube/salty-dog/commit/0996390)) +* **build:** artifact all output ([9eacea6](https://github.com/ssube/salty-dog/commit/9eacea6)) +* **build:** attempt to fix mdl config ([24ebc9e](https://github.com/ssube/salty-dog/commit/24ebc9e)) +* **build:** clean up output directory between builds ([30ea7d6](https://github.com/ssube/salty-dog/commit/30ea7d6)) +* **build:** move sinon to vendor chunk ([d02b223](https://github.com/ssube/salty-dog/commit/d02b223)) +* **build:** run generic build target ([c41d9d0](https://github.com/ssube/salty-dog/commit/c41d9d0)) +* **build:** split index into its own chunk ([8351fff](https://github.com/ssube/salty-dog/commit/8351fff)) +* **container:** set up as cli tool within container ([ef2a9c9](https://github.com/ssube/salty-dog/commit/ef2a9c9)) +* **rules/tsconfig:** correctly enforce lib/target for esnext ([62d58fe](https://github.com/ssube/salty-dog/commit/62d58fe)) ### Build System -* image build and global install targets 8368271 -* remove license from chunks ac86e69 -* remove redundant tsconfig options 37c0dbb -* **package:** set module entry point to main bundle 7e2d20e -* split vendor chunk 96d15bb +* image build and global install targets ([8368271](https://github.com/ssube/salty-dog/commit/8368271)) +* remove license from chunks ([ac86e69](https://github.com/ssube/salty-dog/commit/ac86e69)) +* remove redundant tsconfig options ([37c0dbb](https://github.com/ssube/salty-dog/commit/37c0dbb)) +* **package:** set module entry point to main bundle ([7e2d20e](https://github.com/ssube/salty-dog/commit/7e2d20e)) +* split vendor chunk ([96d15bb](https://github.com/ssube/salty-dog/commit/96d15bb)) ### Features -* **rules:** add tsconfig rules 27843c6 -* **rules:** kubernetes rule to require labels aa350cc -* **rules/tsconfig:** check for suppressed errors d11f3d6 -* **test:** begin testing visitor 31d1977 -* configure renovate for semantic commits fbcc143 -* extend renovate presets 2d0b7ad +* **rules:** add tsconfig rules ([27843c6](https://github.com/ssube/salty-dog/commit/27843c6)) +* **rules:** kubernetes rule to require labels ([aa350cc](https://github.com/ssube/salty-dog/commit/aa350cc)) +* **rules/tsconfig:** check for suppressed errors ([d11f3d6](https://github.com/ssube/salty-dog/commit/d11f3d6)) +* **test:** begin testing visitor ([31d1977](https://github.com/ssube/salty-dog/commit/31d1977)) +* configure renovate for semantic commits ([fbcc143](https://github.com/ssube/salty-dog/commit/fbcc143)) +* extend renovate presets ([2d0b7ad](https://github.com/ssube/salty-dog/commit/2d0b7ad)) diff --git a/docs/workflow.md b/docs/workflow.md index 13b8da8..0d86f53 100644 --- a/docs/workflow.md +++ b/docs/workflow.md @@ -9,7 +9,9 @@ This document covers the project workflow, commit and merge messages, and how to - [Terminal Status](#Terminal-Status) - [Transitions](#Transitions) - [Types](#Types) - - [Branches](#Branches) + - [Git](#Git) + - [Branches](#Branches) + - [Remotes](#Remotes) - [Issues](#Issues) - [Issue Labels](#Issue-Labels) @@ -111,10 +113,20 @@ Do not close the issue until the corresponding branches have been merged and rel - dependency updates - typically handled by Renovate -## Branches +## Git + +### Branches Branches should be named after the primary issue they address, with the issue type and number: `type/#-issue-title` +### Remotes + +Copies of the repo exist on both Github and Gitlab. While they are mirrored, the sync is occasional; pushing to both +will immediately trigger a pipeline. + +**Note:** the `origin` remote must point to Github or `standard-release` does not generate commit links in the +changelog + ## Issues ### Issue Labels