Skip to content

Commit d7a979f

Browse files
committed
chore: Update version information
1 parent a9f4272 commit d7a979f

File tree

3 files changed

+35
-3
lines changed

3 files changed

+35
-3
lines changed

README.md

Lines changed: 33 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -118,7 +118,9 @@ with:
118118
- [Sensor tutorial](examples/Example6_SensorTutorial/Example6_SensorTutorial.ino)
119119
- [Power control](examples/Example7_PowerControl/Example7_PowerControl.ino)
120120

121-
Before running an example, you will need to set the Product Identifier, either in code or on your connected Notecard. Steps on how to do this can be found at [https://dev.blues.io/tools-and-sdks/samples/product-uid](https://dev.blues.io/tools-and-sdks/samples/product-uid).
121+
Before running an example, you will need to set the Product Identifier, either
122+
in code or on your connected Notecard. Steps on how to do this can be found at
123+
[https://dev.blues.io/tools-and-sdks/samples/product-uid](https://dev.blues.io/tools-and-sdks/samples/product-uid).
122124

123125

124126
## Contributing
@@ -256,6 +258,36 @@ in the `tests` array in the `main` function. The entry will occupy it's own line
256258
at the end of the array, and syntax should be as follows,
257259
`{test_name, "test_name"},`.
258260

261+
## Generating a Release
262+
263+
### Update Files
264+
265+
When generating a release of the `note-arduino` library, you will need to update
266+
the version in two places.
267+
268+
- `NoteDefines.h`
269+
270+
The `note-arduino` library provides preprocessor defines to allow for
271+
programmatic access to the version number. The following preprocessor
272+
defines should be updated with the version you wish to publish:
273+
274+
- `NOTE_ARDUINO_VERSION_MAJOR`
275+
- `NOTE_ARDUINO_VERSION_MINOR`
276+
- `NOTE_ARDUINO_VERSION_PATCH`
277+
278+
- `library.properties`
279+
280+
Update the `version` key to reflect the version you wish to publish. The
281+
version string should follow the form "\<major\>.\<minor\>.\<patch\>" (e.g.
282+
`1.6.4`). This value will be used by the Arduino Library Manager.
283+
284+
### GitHub Release
285+
286+
Publishing a release on GitHub will trigger the Arduino Library Manager. The
287+
Arduino Library Manager will then look to the `library.properties` file, and
288+
generate a release based on the `version` value it finds there. It should be
289+
noted, the version on GitHub is not evaluated by the Arduino Library Manager.
290+
259291
## More Information
260292

261293
For additional Notecard SDKs and Libraries, see:

library.properties

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
name=Blues Wireless Notecard
2-
version=1.6.3
2+
version=1.6.4
33
author=Blues
44
maintainer=Blues <[email protected]>
55
sentence=An easy to use Notecard Library for Arduino.

src/NoteDefines.h

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
// Define the version of the `note-arduino` library
55
#define NOTE_ARDUINO_VERSION_MAJOR 1
66
#define NOTE_ARDUINO_VERSION_MINOR 6
7-
#define NOTE_ARDUINO_VERSION_PATCH 3
7+
#define NOTE_ARDUINO_VERSION_PATCH 4
88

99
#define NOTE_ARDUINO_VERSION NOTE_C_STRINGIZE(NOTE_ARDUINO_VERSION_MAJOR) "." NOTE_C_STRINGIZE(NOTE_ARDUINO_VERSION_MINOR) "." NOTE_C_STRINGIZE(NOTE_ARDUINO_VERSION_PATCH)
1010

0 commit comments

Comments
 (0)