Add a ChangeLog file #1206

aggarw13 · 2020-09-09T17:19:20Z

Add a Change Log file to master branch.

Contains history of previous releases on the repository (Change Log re-used from v3.1.0 release)
Adds a new entry for the 202009.00 release

By submitting this pull request, I confirm that my contribution is made under the terms of the MIT license.

codecov-commenter · 2020-09-09T17:20:15Z

Codecov Report

❗ No coverage uploaded for pull request base (release-candidate@efb55f4). Click here to learn what that means.
The diff coverage is n/a.

@@                 Coverage Diff                  @@
##             release-candidate    #1206   +/-   ##
====================================================
  Coverage                     ?   99.70%           
====================================================
  Files                        ?        6           
  Lines                        ?      682           
  Branches                     ?      176           
====================================================
  Hits                         ?      680           
  Misses                       ?        0           
  Partials                     ?        2

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update efb55f4...33f3871. Read the comment docs.

leegeth · 2020-09-09T17:25:28Z

CHANGELOG.md

+   - [FreeRTOS/coreJSON](https://github.com/FreeRTOS/JSON) for JSON parser library
+   - [aws/device-shadow-for-aws-iot-embedded-sdk](https://github.com/aws/device-shadow-for-aws-iot-embedded-sdk) for AWS IoT Shadow service client library.
+- The above library folders in `libraries/` folder has been replaced with submodule to the individual repositories.
+


We may have to mention about the Jobs library is not part of this release as it was part of the earlier release.

Good suggestion. Updated

I think the word we used elsewhere is "refactored". I think we also agreed to have it without the specific date, so just Sept 2020.

can we combine line #11 and #7? The libraries have been submoduled from their individual repos should be enough

I have replaced re-designed with re-factored.
I have combined the 2 bullet points mentioning about the new individual repositories and the use of submodule pointers

Have removed the specific date to just use Month Year format

leegeth · 2020-09-09T17:29:58Z

CHANGELOG.md

+   - [aws/device-shadow-for-aws-iot-embedded-sdk](https://github.com/aws/device-shadow-for-aws-iot-embedded-sdk) for AWS IoT Shadow service client library.
+- The above library folders in `libraries/` folder has been replaced with submodule to the individual repositories.
+
+## [3.0.1](https://github.com/aws/aws-iot-device-sdk-embedded-C/releases/tag/v3.0.1) (May 10, 2018)


We would need to also mention about the tag 3.1.0 which was the latest content in master of V3 CSDK, which was unreleased.

Good point, have added text for the tag

jainamt · 2020-09-09T19:39:59Z

CHANGELOG.md

+## 202009.00 (September 14, 2020)
+
+- This release introduces re-designed MQTT client library, JSON parser library and the AWS IoT Shadow client library.
+- The AWS IoT Jobs service client library is not part of this release. It will be part of a future release.


I dont think we need to call this out aspect of Jobs lib.

Okay, have removed it. Or is there another aspect of the Jobs library that is worth mentioning?

jainamt · 2020-09-09T19:41:20Z

CHANGELOG.md

+- The above library folders in `libraries/` folder has been replaced with submodule to the individual repositories.
+- Commit [6f88ba7](https://github.com/aws/aws-iot-device-sdk-embedded-C/commit/6f88ba7e5471b550f9b9c0fb9bed7ef6e1230caf) has been tagged as [v3.1.0](https://github.com/aws/aws-iot-device-sdk-embedded-C/tree/v3.1.0) SDK. The commit was part of the `master` branch following
+the commit tree of the [v3.0.1](https://github.com/aws/aws-iot-device-sdk-embedded-C/tree/v3.0.1) release. [v3.1.0](https://github.com/aws/aws-iot-device-sdk-embedded-C/tree/v3.1.0) is **NOT** a released
+version.  


what does that mean? its tagged, why is not released?

If I am a customer reading it, what do I take away from it? Should I use v3.1.0 or not?

"Not released" raises these questions.
I believe we should call out v3.1 on a separate line saying that is the last V3 commit as of 09/2020.
I believe by 'not released' we mean no special testing has been performed on the tip of the last master, but we have tagged it for the reference.

Have created a separate section for v3.1.0

jainamt · 2020-09-09T19:42:48Z

CHANGELOG.md

+
+Bugfixes:
+
+  - [#49](https://github.com/aws/aws-iot-device-sdk-embedded-C/issues/49) - Add support for SHADOW_JSON_STRING as supported value


do we need this?

It seems to me that if we list all this, then we need to move to github to all our issues tracking.

This is the content of the Change Log file from the v3.x series as-is. I think there is value in keeping the content of the previous releases untouched.

Ok, if this is from last release, I agree to leave it unchanged.

jainamt · 2020-09-09T19:43:19Z

CHANGELOG.md

@@ -0,0 +1,246 @@
+# Change Log for AWS IoT Embedded C SDK
+
+## 202009.00 (September 14, 2020)


when do we plan to merge this PR? At the day of release because of this info?

I plan to re-target this PR to the release-candidate branch instead of waiting to merge this on the release date

Change log should also go into master.

Based on the new workflow being discussed, I will merge it to master only (and it will be carried-forward to RC)

So if thats the case, I think we need to split this into 2 PRs. Before 9/14, master should get changelog upto v3x release. RC should have 202009.00 changelog. And then RC merges back to master and master gets it. Right?

If the release-candidate branch is going to be merged back to master branch, then this PR can just be re-targeted to the release-candidate branch.
@leegeth, what do you suggest?

I think we can merge it to release-candidate as is. After the release is done, we may just need to update the CHANGELOG.md in master and we can create a PR to do that. We may not need to merge the release-candidate back to master at all though with the new flow. What do you all think about that?

That works for me as long as we have a plan to port back changes from release-candidate to master

The base branch was changed.

…ent in upcoming release

jainamt · 2020-09-10T19:55:51Z

CHANGELOG.md

+
+## 202009.00 (September 2020)
+
+This release is **NOT** backwards compatible with the v3 version of AWS IoT Device SDK for Embedded C.


hmm. I am not an expert on docs, but can we start section about 202009.00 with what it is, rather than what it is not?

That's a good point. Would it be fine if I move this sentence toward the end of the 202009.00 section as the following?

Should we speak to the new versioning scheme we are introducing here ? Perhaps just point to a description of it that exists here - https://docs.aws.amazon.com/freertos/latest/userguide/what-is-freertos.html

Anything to say about CBMC which I believe is an additional value add from last release. Please disregard if this has already been discussed.

Something like this:
"This release cuts over to a date-based versioning scheme. More information about the versioning scheme can be referred in the FreeRTOS AWS docs landing page"

that link may not be the right link. Tanmoy is working on a post that will explain the new versioning and CBMC. I think we should link it from the changelog. Pls check with Tanmoy.

Perhaps something like this - "With this release we are introducing a new date based versioning scheme"

Agree with Amit. Another thing to consider is speak about the yaml file if it is being introduced with this release.

To prevent further delay on this PR, I will make the changes of this discussion thread in a follow-up PR.

jainamt

approved, but there are pending comments from Sachin. Please look into those comments.

leegeth reviewed Sep 9, 2020

View reviewed changes

leegeth previously approved these changes Sep 9, 2020

View reviewed changes

aggarw13 requested review from abhidixi11, yngki and jainamt September 9, 2020 18:14

jainamt reviewed Sep 9, 2020

View reviewed changes

aggarw13 dismissed leegeth’s stale review via 9ed0ca7 September 9, 2020 22:54

jainamt previously approved these changes Sep 10, 2020

View reviewed changes

aggarw13 changed the base branch from master to release-candidate September 10, 2020 16:37

aggarw13 added 8 commits September 10, 2020 18:04

Add a ChangeLog file

6ec318a

Add information about re-designed libraries and Jobs library not pres…

327daff

…ent in upcoming release

Add text about v3.1.0 in changelog

f8810a8

Updates to text from review comments

1540614

Use only month and year for new release

a2a18d8

Create separate section for v3.1.0 and remove point for Jobs library

adb263e

Add a new line for NOTE in v3.1.0 section

9f92b7b

Remove the note from v3.1.0 section

f3a07a7

aggarw13 force-pushed the add-change-log-file branch from c39f11d to f3a07a7 Compare September 10, 2020 18:06

leegeth previously approved these changes Sep 10, 2020

View reviewed changes

aggarw13 requested a review from aggarg September 10, 2020 18:24

yngki previously approved these changes Sep 10, 2020

View reviewed changes

abhidixi11 previously approved these changes Sep 10, 2020

View reviewed changes

jainamt reviewed Sep 10, 2020

View reviewed changes

Move API incompatibility note to bottom of section

33f3871

aggarw13 dismissed stale reviews from abhidixi11, yngki, and leegeth via 33f3871 September 10, 2020 20:45

jainamt approved these changes Sep 10, 2020

View reviewed changes

leegeth approved these changes Sep 10, 2020

View reviewed changes

aggarw13 merged commit d279385 into aws:release-candidate Sep 10, 2020

aggarw13 deleted the add-change-log-file branch September 10, 2020 22:23

jainamt mentioned this pull request Sep 11, 2020

Update CHANGELOG in master #1223

Merged

leegeth pushed a commit to leegeth/aws-iot-device-sdk-embedded-C that referenced this pull request Sep 11, 2020

Add a CHANGELOG file (aws#1206)

d6c2d10

leegeth pushed a commit to leegeth/aws-iot-device-sdk-embedded-C that referenced this pull request Sep 12, 2020

Add a CHANGELOG file (aws#1206)

54bee72

leegeth pushed a commit to leegeth/aws-iot-device-sdk-embedded-C that referenced this pull request Sep 15, 2020

Add a CHANGELOG file (aws#1206)

b308b81

leegeth pushed a commit to leegeth/aws-iot-device-sdk-embedded-C that referenced this pull request Sep 16, 2020

Add a CHANGELOG file (aws#1206)

6c97f01


		Bugfixes:

		- [#49](https://github.com/aws/aws-iot-device-sdk-embedded-C/issues/49) - Add support for SHADOW_JSON_STRING as supported value

		@@ -0,0 +1,246 @@
		# Change Log for AWS IoT Embedded C SDK

		## 202009.00 (September 14, 2020)


		## 202009.00 (September 2020)

		This release is NOT backwards compatible with the v3 version of AWS IoT Device SDK for Embedded C.

Add a ChangeLog file #1206

Add a ChangeLog file #1206

Conversation

aggarw13 commented Sep 9, 2020

codecov-commenter commented Sep 9, 2020 • edited Loading

Codecov Report

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

aggarw13 Sep 9, 2020 • edited Loading

Choose a reason for hiding this comment

jainamt Sep 9, 2020 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

aggarw13 Sep 10, 2020 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

aggarw13 Sep 10, 2020 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jainamt left a comment

Choose a reason for hiding this comment

codecov-commenter commented Sep 9, 2020 •

edited

Loading

aggarw13 Sep 9, 2020 •

edited

Loading

jainamt Sep 9, 2020 •

edited

Loading

aggarw13 Sep 10, 2020 •

edited

Loading

aggarw13 Sep 10, 2020 •

edited

Loading