Skip to content

Commit 5a27f8f

Browse files
authored
Updated version for release (#89)
* Updated version for release * Updated version number in config.doxyfile * Updated manifest.yml * Updated header copyright to 2021 * Updated CHANGELOG
1 parent c37a8a4 commit 5a27f8f

File tree

11 files changed

+32
-15
lines changed

11 files changed

+32
-15
lines changed

.github/workflows/ci.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -101,4 +101,4 @@ jobs:
101101
uses: FreeRTOS/CI-CD-Github-Actions/memory_statistics@main
102102
with:
103103
config: .github/memory_statistics_config.json
104-
check_against: docs/doxygen/include/size_table.html
104+
check_against: docs/doxygen/include/size_table.md

.github/workflows/memory_statistics.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,4 +19,4 @@ jobs:
1919
uses: actions/upload-artifact@v2
2020
with:
2121
name: size_table
22-
path: size_table.html
22+
path: size_table.md

CHANGELOG.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,10 @@
11
# Changelog for AWS IoT Device Shadow library
2-
## v1.1.1 (May 2021)
2+
3+
## v1.1.1 (July 2021)
34

45
### Other
56
- [#85](https://github.com/aws/Device-Shadow-for-AWS-IoT-embedded-sdk/pull/85) Fix CBMC proof for `Shadow_AssembleTopicString` API.
7+
- [#88](https://github.com/aws/Device-Shadow-for-AWS-IoT-embedded-sdk/pull/88) Update broken MISRA link
68

79
## v1.1.0 (March 2021)
810

README.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -65,6 +65,20 @@ Please refer to the demos of the AWS IoT Device Shadow library in the following
6565
| FreeRTOS | [FreeRTOS/FreeRTOS](https://github.com/FreeRTOS/FreeRTOS/tree/master/FreeRTOS-Plus/Demo/AWS/Device_Shadow_Windows_Simulator) | FreeRTOS+TCP for TCP/IP and mbedTLS for TLS stack |
6666
| FreeRTOS | [FreeRTOS AWS Reference Integrations](https://github.com/aws/amazon-freertos/tree/master/demos/device_shadow_for_aws) | Based on Secure Sockets Abstraction |
6767

68+
## Documentation
69+
70+
### Existing Documentation
71+
72+
For pre-generated documentation, please see the documentation linked in the locations below:
73+
74+
| Location |
75+
| :-: |
76+
| [AWS IoT Device SDK for Embedded C](https://github.com/aws/aws-iot-device-sdk-embedded-C#releases-and-documentation) |
77+
| [FreeRTOS.org](https://freertos.org/Documentation/api-ref/device-shadow-for-aws-iot-embedded-sdk/docs/doxygen/output/html/index.html) |
78+
79+
Note that the latest included version of IoT Device Shadow library may differ across repositories.
80+
81+
6882
## Generating documentation
6983

7084
The Doxygen references were created using Doxygen version 1.8.20. To generate the

docs/doxygen/config.doxyfile

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ PROJECT_NAME = "AWS IoT Device Shadow"
3838
# could be handy for archiving the generated documentation or if some version
3939
# control system is used.
4040

41-
PROJECT_NUMBER = "v1.1.0"
41+
PROJECT_NUMBER = "v1.1.1"
4242

4343
# Using the PROJECT_BRIEF tag one can provide an optional one line description
4444
# for a project that appears at the top of each page and should give viewer a
File renamed without changes.

docs/doxygen/pages.dox

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ Embedded devices often use MQTT to interact with Device Shadow. This library pro
1515
@section shadow_memory_requirements Memory Requirements
1616
@brief Memory requirements of the Shadow library.
1717

18-
@include{doc} size_table.html
18+
@include{doc} size_table.md
1919
*/
2020

2121
/**

lexicon.txt

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -15,10 +15,10 @@ css
1515
defgroup
1616
developerguide
1717
device-shadow-limits
18+
doxygen
1819
endcode
1920
endif
2021
endlink
21-
doxygen
2222
gcc
2323
generatedtopicstringlength
2424
getshadowoperationlength
@@ -44,6 +44,7 @@ mainpage
4444
malloc
4545
matchtopic
4646
maxallowedlength
47+
md
4748
mdash
4849
messagetype
4950
mqtt
@@ -59,10 +60,10 @@ outlength
5960
param
6061
pconsumedtopiclength
6162
pmessagetype
62-
png
63-
posix
6463
pname
6564
pnamelength
65+
png
66+
posix
6667
poutlength
6768
pre
6869
pshadowname
@@ -85,12 +86,12 @@ shadowtopicstringtypedeleterejected
8586
shadowtopicstringtypeget
8687
shadowtopicstringtypegetaccepted
8788
shadowtopicstringtypegetrejected
89+
shadowtopicstringtypemaxnum
8890
shadowtopicstringtypeupdate
8991
shadowtopicstringtypeupdateaccepted
9092
shadowtopicstringtypeupdatedelta
9193
shadowtopicstringtypeupdatedocuments
9294
shadowtopicstringtypeupdaterejected
93-
shadowtopicstringtypemaxnum
9495
sizeof
9596
stdint
9697
stringlength
@@ -110,5 +111,5 @@ topiclength
110111
topicnamelength
111112
topictype
112113
tr
113-
utest
114114
un
115+
utest

manifest.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
name : "Device-Shadow-for-AWS-IoT-embedded-sdk"
2-
version: "v1.1.0"
2+
version: "v1.1.1"
33
description: |
44
"Client library for using the AWS IoT Device Shadow service on embedded devices.\n"
55
license: "MIT"

source/include/shadow.h

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
/*
2-
* AWS IoT Device Shadow v1.1.0
3-
* Copyright (C) 2020 Amazon.com, Inc. or its affiliates. All Rights Reserved.
2+
* AWS IoT Device Shadow v1.1.1
3+
* Copyright (C) 2021 Amazon.com, Inc. or its affiliates. All Rights Reserved.
44
*
55
* Permission is hereby granted, free of charge, to any person obtaining a copy of
66
* this software and associated documentation files (the "Software"), to deal in

0 commit comments

Comments
 (0)