Skip to content

Commit d07ad2c

Browse files
gen2thomasgen2thomas
authored
all: prepare for release v2.0.0
1 parent 0156c3c commit d07ad2c

File tree

5 files changed

+172
-1
lines changed

5 files changed

+172
-1
lines changed

‎.chglog/CHANGELOG.gobot.md‎

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
{{ range .Versions }}
2+
{{ if .Tag.Previous }}{{ .Tag.Name }}{{ else }}{{ .Tag.Name }}{{ end }}
3+
---
4+
{{ range .CommitGroups -}}
5+
* **{{ .Title }}**
6+
7+
{{ range .Commits -}}
8+
* {{ if .Scope }}**>{{ .Scope }}:<** {{ end }}{{ .Subject }}
9+
{{ end }}
10+
{{ end -}}
11+
12+
{{- if .NoteGroups -}}
13+
{{ range .NoteGroups -}}
14+
### {{ .Title }}
15+
16+
{{ range .Notes }}
17+
{{ .Body }}
18+
{{ end }}
19+
{{ end -}}
20+
{{ end -}}
21+
{{ end -}}

‎.chglog/README.md‎

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
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+
## Usage
8+
9+
Example for a new release "v2.0.0":
10+
11+
```sh
12+
git fetch --tags
13+
git-chglog --no-case --next-tag 2.0.0 v1.16.0.. > .chglog/chglog_tmp.md
14+
```
15+
16+
## Compare
17+
18+
If unsure about any result of running git-chglog, just use:
19+
`git log --since=2022-05-02 --pretty="- %s`
20+
21+
## Manual adjustment
22+
23+
Because there is no commit style guide yet, some manual work is needed to bring the items in the correct position.
24+
Please refer to the current CHANGELOG.md to find the correct way. In general we try to use this style:
25+
26+
* titles will be converted to lower case
27+
* titles are lexical ordered
28+
* each platform has its own title (e.g. **raspi**)
29+
* fixes has the title **bugfix**
30+
* title **api**, **drivers** or **example** is used for changes below related folder
31+
* title **core** is used for changes of common code, e.g. utilities, system
32+
* further special titles **build**, **docs** and **test** can be used
33+
34+
## Finalization
35+
36+
After all work is done in the temporary changelog file, the content can be moved to the real one and the "chglog_tmp.md"
37+
file can be removed.
38+
39+
## TODO's
40+
41+
* introduce a commit style guide
42+
* convert the changelog format to a more common style, see <https://github.com/git-chglog/example-type-scope-subject/tree/master>

‎.chglog/config.yml‎

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
style: github
2+
template: CHANGELOG.gobot.md
3+
info:
4+
title: CHANGELOG
5+
repository_url: https://github.com/hybridgroup/gobot
6+
options:
7+
commits:
8+
# filters:
9+
# Type:
10+
# - feat
11+
# - fix
12+
# - perf
13+
# - refactor
14+
commit_groups:
15+
# title_maps:
16+
# feat: Features
17+
# fix: Bug Fixes
18+
# perf: Performance Improvements
19+
# refactor: Code Refactoring
20+
header:
21+
pattern: "^(\\w*)(?:\\(([\\w\\$\\.\\-\\*\\s]*)\\))?\\:?\\s(.*)$"
22+
pattern_maps:
23+
- Type
24+
- Scope
25+
- Subject
26+
notes:
27+
keywords:
28+
- BREAKING CHANGE

‎CHANGELOG.md‎

Lines changed: 80 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,83 @@
1+
2.0.0
2+
---
3+
* **bugfix**
4+
* I2C connection-bus caching and multiple device usage
5+
* raspi pwm cache
6+
* new pwm behaviour of tinkerboard
7+
* jetson nano pwm feature
8+
* examples and gopigo3 driver
9+
* i2c.ReadBlockData(), Read_Data() in digispark and some small other fixes
10+
* L3GD20H full scale range usage
11+
* TH02 wrong register usage for read heater
12+
* MPU6050 wrong initialize and reduced temperature resolution
13+
* I2C driver typo: change HMC8553L to HMC5883L
14+
* HMC5883L driver returns wrong values
15+
* ads1x15 driver not working stable when reading multiple inputs
16+
* Adafruit1109 driver shows bad characters after Halt()
17+
* spi.SpiConnection is not gobot.Connection: missing method Connect
18+
* Stopping and Starting Robot with Raspberry Pi Adapter and LED Driver - LED does not toggle on restart
19+
* **ble**
20+
* update to TinyGo Bluetooth package v0.6.0 release
21+
* **build**
22+
* update appveyor for go 1.19
23+
* switch to new cimg with golang 1.17
24+
* new home path for cimg
25+
* check examples in CI ([#884](https://github.com/hybridgroup/gobot/issues/884))
26+
* add tests of more platforms to CI
27+
* add configuration file for dependabot ([#907](https://github.com/hybridgroup/gobot/issues/907))
28+
* add PR template
29+
* **core**
30+
* use base driver for all I2C devices
31+
* rename package "sysfs" to "system"
32+
* go.mod to 1.17 and all modules incl. code upgrades
33+
* **dji tello**
34+
* Halt does not terminate all the related goroutines and may wait forever when it is called multiple times
35+
* **docs**
36+
* README for gpio, pwm, i2c and add example
37+
* document fields for flight data
38+
* **drivers**
39+
* ADXL345 use ReadBlockData()
40+
* CCS811 use ReadBlockData()
41+
* bmxy8z use ReadBlockData
42+
* CCS811 use ReadBlockData()
43+
* BMP180, BMP280 BMP388 BME280 use ReadBlockData()
44+
* MPL115A2 use ReadBlockData(), WriteByteData()
45+
* add generic i2c driver
46+
* add PCF8583 i2c driver
47+
* add PCA9501 i2c driver
48+
* add PCA953x i2c driver
49+
* introduce I2cBusAdaptor for composition in platforms
50+
* introduce generic i2c.Driver with example for digispark fix missing/wrong entries in README stabilize test
51+
* add advanced digital pin options (pull, bias, drive, debounce, event)
52+
* add support for new character device Kernel ABI for GPIO
53+
* analog sensor driver to prevent ReadValue() to get float64
54+
* add read firmware version and DHT sensors for grovepi
55+
* SPI using GPIO's plus driver for MFRC522
56+
* **jetson nano**
57+
* add Jetson Nano adpator
58+
* **joystick**
59+
* add Xbox-One controller
60+
* add configuration for Nintendo Switch controllers ([#903](https://github.com/hybridgroup/gobot/issues/903))
61+
* add Dualsense joystick (PlayStation 5) ([#880](https://github.com/hybridgroup/gobot/issues/880))
62+
* **nanopi neo**
63+
* add platform
64+
* **piblaster**
65+
* add unused but missing interface implementation
66+
* **radxa rock pi 4(c+)**
67+
* add platform ([#902](https://github.com/hybridgroup/gobot/issues/902))
68+
* **test**
69+
* increase some timings to make tests a little less fragile
70+
* skip test TestNatsAdaptorFailedConnect when flaky
71+
* stabilize "every"-test
72+
* stabilize flaky utils_test
73+
* stabilize firmata tests
74+
* fix tests with sysfs mocks, ReadBlockData, WriteBlockData
75+
* fix keyboard tests and exclude opencv
76+
* fix PWM related read/write tests
77+
* add check for examples in Makefile
78+
* **BREAKING CANGES**
79+
* some interfaces moved, see folder system and adaptor.go
80+
181
1.16.0
282
---
383
* **bugfix**

‎version.go‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
package gobot
22

3-
const version = "1.16.0"
3+
const version = "2.0.0"
44

55
// Version returns the current Gobot version
66
func Version() string {

0 commit comments

Comments
 (0)