Update of changelog template and example #36

tanjadegroot · 2024-06-19T10:52:55Z

What type of PR is this?

Add one of the following kinds:

documentation

What this PR does / why we need it:

The template of the CHANGELOG was adapted to the Release Management Process and to account for multiple APIs in an API Sub Project release. The template file is moved from Commonalities to Release Management.

Which issue(s) this PR fixes:

Fixes #25

Special notes for reviewers:

Changelog input

- CHANGELOG template was adapted to the Release Management Process 
- take into account having multiple APIs in an API Sub Project release.
- Move file form Commonalities to Release Management

Additional documentation

Per issue camaraproject#25

update template to refer to releases

extended example

review comments on RM call

updates on release types

updates following review on June 11 RM call

Update after discussion in RM call on June 18 2024 Other content will be moved to example file

Adapted changelog example file

soadeyemo

Reviewed and approved.

rartych · 2024-06-19T13:50:27Z

The Commonalities template is currently in SupportingDocuments:

https://github.com/camaraproject/Commonalities/blob/main/documentation/SupportingDocuments/CHANGELOG_TEMPLATE.md

Should it be removed or deprecated?

hdamker · 2024-06-20T16:25:37Z

@rartych

Should it be removed or deprecated?

As discussed within TSC: in the current release "deprecated" with a text similar to https://github.com/camaraproject/Commonalities/blob/main/documentation/API-Readiness-Checklist.md. To be deleted in a later release.

rartych · 2024-06-21T12:16:32Z

As discussed within TSC: in the current release "deprecated" with a text similar to https://github.com/camaraproject/Commonalities/blob/main/documentation/API-Readiness-Checklist.md. To be deleted in a later release.

Solved in camaraproject/Commonalities#239

documentation/CHANGELOG_EXAMPLE.md

documentation/CHANGELOG_TEMPLATE.md

hdamker · 2024-06-21T16:03:30Z

Sorry for the many comments ... I tried to "rewrite" the example via suggestions which was maybe not the best idea. An alternative to the use of the QoD CHANGELOG as the base for the example could be to write a much simpler but hypothetical one.

Some of the comments within the example are also relevant for the template.

documentation/CHANGELOG_EXAMPLE.md

proposal Herbert Co-authored-by: Herbert Damker <52109189+hdamker@users.noreply.github.com>

Comments herbert: - put back original Changelog for v0.9.0 and older - removed backward compatibility statements in references section

herbert's comments 2

update after herbert comments

updated fake URLs with release numbers iso API version numbers

changed titles to be a bit more meaningful

crosse checked all Herbert comments - ready for review

cross checked all herbert's comments - ready for review.

update in RM call

update on RM call

Co-authored-by: Herbert Damker <52109189+hdamker@users.noreply.github.com>

final comments Herbert

Changelog - input following Herbert's comments

remove older versions and propagate changes to rc and public (to be continued)

final comments Herbert

tanjadegroot · 2024-06-28T00:50:20Z

@hdamker @soadeyemo and others, please review

tanjadegroot added 15 commits May 28, 2024 15:55

Copy from file in Commonalities

8687659

Per issue camaraproject#25

Update CHANGELOG_TEMPLATE.md

28e9167

update template to refer to releases

Update CHANGELOG_TEMPLATE.md

8e78fee

extended example

Update CHANGELOG_TEMPLATE.md

60d20ee

review comments on RM call

Update CHANGELOG_TEMPLATE.md

67e86a9

updates on release types

Update CHANGELOG_TEMPLATE.md

99e803f

updates following review on June 11 RM call

Update CHANGELOG_TEMPLATE.md

6f08ae0

Update after discussion in RM call on June 18 2024 Other content will be moved to example file

Update CHANGELOG_TEMPLATE.md

9c2cae7

Update CHANGELOG_TEMPLATE.md

b8f8af3

Add files via upload

63570af

Update CHANGELOG_EXAMPLE.md

21a616a

Adapted changelog example file

Update CHANGELOG_EXAMPLE.md

512686c

Update CHANGELOG_TEMPLATE.md

a6f5508

Update CHANGELOG_EXAMPLE.md

0ad862b

Update CHANGELOG_TEMPLATE.md

097fd8d

tanjadegroot requested a review from soadeyemo as a code owner June 19, 2024 10:52

soadeyemo previously approved these changes Jun 19, 2024

View reviewed changes

hdamker requested a review from a team June 19, 2024 11:24

hdamker requested changes Jun 21, 2024

View reviewed changes

documentation/CHANGELOG_TEMPLATE.md Outdated Show resolved Hide resolved

documentation/CHANGELOG_TEMPLATE.md Outdated Show resolved Hide resolved

documentation/CHANGELOG_TEMPLATE.md Outdated Show resolved Hide resolved

hdamker reviewed Jun 21, 2024

View reviewed changes

documentation/CHANGELOG_EXAMPLE.md Outdated Show resolved Hide resolved

hdamker reviewed Jun 21, 2024

View reviewed changes

documentation/CHANGELOG_EXAMPLE.md Outdated Show resolved Hide resolved

Update documentation/CHANGELOG_EXAMPLE.md

bc88906

proposal Herbert Co-authored-by: Herbert Damker <52109189+hdamker@users.noreply.github.com>

tanjadegroot dismissed soadeyemo’s stale review via bc88906 June 23, 2024 21:10

tanjadegroot added 2 commits June 23, 2024 23:28

Update CHANGELOG_EXAMPLE.md

06d7796

Comments herbert: - put back original Changelog for v0.9.0 and older - removed backward compatibility statements in references section

Update CHANGELOG_EXAMPLE.md

170d13f

herbert's comments 2

tanjadegroot added 8 commits June 25, 2024 11:47

Update CHANGELOG_TEMPLATE.md

7e3cd0e

update after herbert comments

Update CHANGELOG_TEMPLATE.md

09c3ca2

update after herbert comments

Update CHANGELOG_EXAMPLE.md

1591fe1

updated fake URLs with release numbers iso API version numbers

Update CHANGELOG_TEMPLATE.md

75e4dc5

Update CHANGELOG_EXAMPLE.md

77e420b

changed titles to be a bit more meaningful

Update CHANGELOG_EXAMPLE.md

c9b9d94

crosse checked all Herbert comments - ready for review

Update CHANGELOG_TEMPLATE.md

3d6cd81

cross checked all herbert's comments - ready for review.

Update CHANGELOG_TEMPLATE.md

b66e422

update in RM call

hdamker marked this pull request as draft June 25, 2024 15:25

tanjadegroot and others added 7 commits June 25, 2024 17:55

Update CHANGELOG_EXAMPLE.md

9927eee

update on RM call

Update documentation/CHANGELOG_EXAMPLE.md

550207f

Co-authored-by: Herbert Damker <52109189+hdamker@users.noreply.github.com>

Update documentation/CHANGELOG_EXAMPLE.md

552ee19

Co-authored-by: Herbert Damker <52109189+hdamker@users.noreply.github.com>

Update CHANGELOG_EXAMPLE.md

bcf1681

final comments Herbert

Update CHANGELOG_TEMPLATE.md

53aa397

final comments Herbert

Update CHANGELOG_TEMPLATE.md

d8b7b9a

final comments Herbert

Merge pull request #1 from nokia/Changelog---Herbert-comments

686832c

Changelog - input following Herbert's comments

tanjadegroot marked this pull request as ready for review June 25, 2024 18:14

tanjadegroot marked this pull request as draft June 26, 2024 00:34

tanjadegroot added 4 commits June 26, 2024 02:45

Update CHANGELOG_EXAMPLE.md

bfdac26

remove older versions and propagate changes to rc and public (to be continued)

Update CHANGELOG_EXAMPLE.md

5afe3d2

final comments Herbert

Update CHANGELOG_EXAMPLE.md

4ede0ed

Update CHANGELOG_EXAMPLE.md

a3c6658

tanjadegroot marked this pull request as ready for review June 26, 2024 20:51

tanjadegroot requested a review from hdamker June 28, 2024 00:43

hdamker approved these changes Jul 2, 2024

View reviewed changes

soadeyemo self-requested a review July 2, 2024 16:21

soadeyemo approved these changes Jul 2, 2024

View reviewed changes

soadeyemo merged commit b855feb into camaraproject:main Jul 2, 2024

tanjadegroot deleted the Update-of-Changelog-template branch July 26, 2024 11:39

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Update of changelog template and example #36

Update of changelog template and example #36

tanjadegroot commented Jun 19, 2024

soadeyemo left a comment

rartych commented Jun 19, 2024

hdamker commented Jun 20, 2024

rartych commented Jun 21, 2024

hdamker commented Jun 21, 2024

tanjadegroot commented Jun 28, 2024

Update of changelog template and example #36

Update of changelog template and example #36

Conversation

tanjadegroot commented Jun 19, 2024

What type of PR is this?

What this PR does / why we need it:

Which issue(s) this PR fixes:

Special notes for reviewers:

Changelog input

Additional documentation

soadeyemo left a comment

Choose a reason for hiding this comment

rartych commented Jun 19, 2024

hdamker commented Jun 20, 2024

rartych commented Jun 21, 2024

hdamker commented Jun 21, 2024

tanjadegroot commented Jun 28, 2024