Skip to content

Commit c417204

Browse files
committed
release template_v1.0.1
See CHANGELOG for details Signed-off-by: Mike Szczys <[email protected]>
1 parent 2dc1038 commit c417204

File tree

2 files changed

+36
-3
lines changed

2 files changed

+36
-3
lines changed

CHANGELOG.md

Lines changed: 9 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -7,11 +7,17 @@ All notable changes to this project will be documented in this file.
77
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
88
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
99

10-
## [1.0.1] - TBD
10+
## [1.0.1] - 2023-07-14
1111

1212
### Fixed
13-
- Turn Golioth LED on when connected
14-
- Desired endpoints will be correctly reset when example_int1 is changed by itself
13+
- Turn on Golioth LED when connected
14+
- Correctly reset `desired` endpoints when `example_int1` is changed by itself
15+
- Fix deadlock behavior when running `set_log_level` RPC multiple times
16+
- Add missing license info
17+
- Removed unused dependencies
18+
- Code formatting
19+
- Typos
20+
- Document forking/merging recommendations
1521

1622
## [1.0.0] - 2023-07-11
1723

README.rst

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -170,6 +170,33 @@ from ``west.yml`` and remove the includes/function calls from the C code.
170170
* `libostentus`_ is a helper library for controlling the Ostentus ePaper
171171
faceplate
172172

173+
Using this template to start a new project
174+
******************************************
175+
176+
Fork this template to create your own Reference Design. After checking out your fork, we recommend
177+
the following workflow to pull in future changes:
178+
179+
* Setup
180+
* Create a ``template`` remote based on the Reference Design Template repository
181+
* Merge in template changes
182+
* Fetch template changes and tags
183+
* Merge template release tag into your ``main`` (or other branch)
184+
* Resolve merge conflicts (if any) and commit to your repository
185+
186+
.. code-block:: console
187+
# Setup
188+
git remote add template https://github.com/golioth/reference-design-template.git
189+
git fetch template --tags
190+
191+
# Merge in template changes
192+
git fetch template --tags
193+
git checkout your_local_branch
194+
git merge template_v1.0.0
195+
196+
# Resolve merge conflicts if necessry
197+
git add resolved_files
198+
git commit
199+
173200
.. _Golioth Console: https://console.golioth.io
174201
.. _Nordic nRF9160 DK: https://www.nordicsemi.com/Products/Development-hardware/nrf9160-dk
175202
.. _golioth-zephyr-boards: https://github.com/golioth/golioth-zephyr-boards

0 commit comments

Comments
 (0)