Skip to content

Commit

Permalink
all: prepare for release v2.0.0
Browse files Browse the repository at this point in the history
  • Loading branch information
gen2thomas authored May 15, 2023
1 parent 0156c3c commit d07ad2c
Show file tree
Hide file tree
Showing 5 changed files with 172 additions and 1 deletion.
21 changes: 21 additions & 0 deletions .chglog/CHANGELOG.gobot.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
{{ range .Versions }}
{{ if .Tag.Previous }}{{ .Tag.Name }}{{ else }}{{ .Tag.Name }}{{ end }}
---
{{ range .CommitGroups -}}
* **{{ .Title }}**

{{ range .Commits -}}
* {{ if .Scope }}**>{{ .Scope }}:<** {{ end }}{{ .Subject }}
{{ end }}
{{ end -}}

{{- if .NoteGroups -}}
{{ range .NoteGroups -}}
### {{ .Title }}

{{ range .Notes }}
{{ .Body }}
{{ end }}
{{ end -}}
{{ end -}}
{{ end -}}
42 changes: 42 additions & 0 deletions .chglog/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
# Creating a changelog automatically

## Install and configure tool

We using <https://github.com/git-chglog/git-chglog>, so refer to this side for installation instructions.

## Usage

Example for a new release "v2.0.0":

```sh
git fetch --tags
git-chglog --no-case --next-tag 2.0.0 v1.16.0.. > .chglog/chglog_tmp.md
```

## Compare

If unsure about any result of running git-chglog, just use:
`git log --since=2022-05-02 --pretty="- %s`

## Manual adjustment

Because there is no commit style guide yet, some manual work is needed to bring the items in the correct position.
Please refer to the current CHANGELOG.md to find the correct way. In general we try to use this style:

* titles will be converted to lower case
* titles are lexical ordered
* each platform has its own title (e.g. **raspi**)
* fixes has the title **bugfix**
* title **api**, **drivers** or **example** is used for changes below related folder
* title **core** is used for changes of common code, e.g. utilities, system
* further special titles **build**, **docs** and **test** can be used

## Finalization

After all work is done in the temporary changelog file, the content can be moved to the real one and the "chglog_tmp.md"
file can be removed.

## TODO's

* introduce a commit style guide
* convert the changelog format to a more common style, see <https://github.com/git-chglog/example-type-scope-subject/tree/master>
28 changes: 28 additions & 0 deletions .chglog/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
style: github
template: CHANGELOG.gobot.md
info:
title: CHANGELOG
repository_url: https://github.com/hybridgroup/gobot
options:
commits:
# filters:
# Type:
# - feat
# - fix
# - perf
# - refactor
commit_groups:
# title_maps:
# feat: Features
# fix: Bug Fixes
# perf: Performance Improvements
# refactor: Code Refactoring
header:
pattern: "^(\\w*)(?:\\(([\\w\\$\\.\\-\\*\\s]*)\\))?\\:?\\s(.*)$"
pattern_maps:
- Type
- Scope
- Subject
notes:
keywords:
- BREAKING CHANGE
80 changes: 80 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,83 @@
2.0.0
---
* **bugfix**
* I2C connection-bus caching and multiple device usage
* raspi pwm cache
* new pwm behaviour of tinkerboard
* jetson nano pwm feature
* examples and gopigo3 driver
* i2c.ReadBlockData(), Read_Data() in digispark and some small other fixes
* L3GD20H full scale range usage
* TH02 wrong register usage for read heater
* MPU6050 wrong initialize and reduced temperature resolution
* I2C driver typo: change HMC8553L to HMC5883L
* HMC5883L driver returns wrong values
* ads1x15 driver not working stable when reading multiple inputs
* Adafruit1109 driver shows bad characters after Halt()
* spi.SpiConnection is not gobot.Connection: missing method Connect
* Stopping and Starting Robot with Raspberry Pi Adapter and LED Driver - LED does not toggle on restart
* **ble**
* update to TinyGo Bluetooth package v0.6.0 release
* **build**
* update appveyor for go 1.19
* switch to new cimg with golang 1.17
* new home path for cimg
* check examples in CI ([#884](https://github.com/hybridgroup/gobot/issues/884))
* add tests of more platforms to CI
* add configuration file for dependabot ([#907](https://github.com/hybridgroup/gobot/issues/907))
* add PR template
* **core**
* use base driver for all I2C devices
* rename package "sysfs" to "system"
* go.mod to 1.17 and all modules incl. code upgrades
* **dji tello**
* Halt does not terminate all the related goroutines and may wait forever when it is called multiple times
* **docs**
* README for gpio, pwm, i2c and add example
* document fields for flight data
* **drivers**
* ADXL345 use ReadBlockData()
* CCS811 use ReadBlockData()
* bmxy8z use ReadBlockData
* CCS811 use ReadBlockData()
* BMP180, BMP280 BMP388 BME280 use ReadBlockData()
* MPL115A2 use ReadBlockData(), WriteByteData()
* add generic i2c driver
* add PCF8583 i2c driver
* add PCA9501 i2c driver
* add PCA953x i2c driver
* introduce I2cBusAdaptor for composition in platforms
* introduce generic i2c.Driver with example for digispark fix missing/wrong entries in README stabilize test
* add advanced digital pin options (pull, bias, drive, debounce, event)
* add support for new character device Kernel ABI for GPIO
* analog sensor driver to prevent ReadValue() to get float64
* add read firmware version and DHT sensors for grovepi
* SPI using GPIO's plus driver for MFRC522
* **jetson nano**
* add Jetson Nano adpator
* **joystick**
* add Xbox-One controller
* add configuration for Nintendo Switch controllers ([#903](https://github.com/hybridgroup/gobot/issues/903))
* add Dualsense joystick (PlayStation 5) ([#880](https://github.com/hybridgroup/gobot/issues/880))
* **nanopi neo**
* add platform
* **piblaster**
* add unused but missing interface implementation
* **radxa rock pi 4(c+)**
* add platform ([#902](https://github.com/hybridgroup/gobot/issues/902))
* **test**
* increase some timings to make tests a little less fragile
* skip test TestNatsAdaptorFailedConnect when flaky
* stabilize "every"-test
* stabilize flaky utils_test
* stabilize firmata tests
* fix tests with sysfs mocks, ReadBlockData, WriteBlockData
* fix keyboard tests and exclude opencv
* fix PWM related read/write tests
* add check for examples in Makefile
* **BREAKING CANGES**
* some interfaces moved, see folder system and adaptor.go

1.16.0
---
* **bugfix**
Expand Down
2 changes: 1 addition & 1 deletion version.go
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
package gobot

const version = "1.16.0"
const version = "2.0.0"

// Version returns the current Gobot version
func Version() string {
Expand Down

0 comments on commit d07ad2c

Please sign in to comment.