gobot.io/x/gobot/v2@v2.1.0/.chglog/README.md (about) 1 # Creating a changelog automatically 2 3 ## Install and configure tool 4 5 We using <https://github.com/git-chglog/git-chglog>, so refer to this side for installation instructions. 6 7 It is possible to test the tool by `git-chglog --init` without overriding anything. 8 9 ## Usage 10 11 Example for a new release "v2.0.2": 12 13 ```sh 14 git checkout release 15 git pull 16 git fetch --tags 17 git checkout dev 18 git pull upstream dev 19 git-chglog --config .chglog/config_gobot.yml --no-case --next-tag v2.0.2 v2.0.1.. > .chglog/chglog_tmp.md 20 ``` 21 22 ## Compare 23 24 If unsure about any result of running git-chglog, just use: 25 `git log --since=2023-05-20 --pretty="- %s"` 26 27 ## Manual adjustment 28 29 Most likely some manual work is needed to bring the items in the correct position. We use the style from 30 ["keep a changelog"](https://keepachangelog.com/en/1.1.0/), together with the [standard template](https://github.com/git-chglog/example-type-scope-subject/blob/master/CHANGELOG.standard.md). 31 The changelog will be generated based on the commit messages, so please follow the 32 [Convention for Pull Request Descriptions](../CONTRIBUTING.md). 33 34 An example for the following commits: 35 36 * type(scope): description 37 * i2c(PCF8583): added 38 * gpio(HD44780): fix wrong constants 39 * raspi(PWM): refactor usage 40 * docs(core): usage of Kernel driver 41 * or alternative: core(docs): usage of Kernel driver 42 * build(style): adjust rule for golangci-lint 43 44 ```md 45 ### build 46 47 * **style**: adjust rule for golangci-lint 48 49 ### docs 50 51 * **core**: usage of Kernel driver 52 53 ### i2c 54 55 * **PCF8583**: added 56 57 58 ### gpio 59 60 * **HD44780**: fix wrong constants 61 62 ### raspi 63 64 * **PWM**: refactor usage 65 66 ### Type 67 68 * **scope:** description 69 ``` 70 71 If in doubt, please refer to the current CHANGELOG.md to find the correct way. 72 73 ## Finalization 74 75 After all work is done in the temporary changelog file, the content can be moved to the real one and the "chglog_tmp.md" 76 file can be removed.