#246 Add issues and links to issues in release notes
Merged by thunderbirdtr. Opened by meltayeb.
fedora-web/ meltayeb/websites ReleaseNotes  into  master

Download 246.patch

Add issues from JSON and links to those issues in CoreOS release notes. Also add indentation.

@dustymabe @siosm @lucab

LGTM. Is this fetching all streams at once? Could we fetch only the stream we need as required?

https://siosm.fedorapeople.org/Screenshot%202022-05-17%20at%2015-07-26%20Get%20Fedora.png

2 new commits added

  • Add issues and links to issues in release notes
  • Add indentation for coreos-release-notes.js

1 new commit added

  • Add issues and links to issues in release notes

2 new commits added

  • Add issues and links to issues in release notes
  • Add indentation for coreos-release-notes.js

1 new commit added

  • Add issues and links to issues in release notes

2 new commits added

  • Add issues and links to issues in release notes
  • Add indentation for coreos-release-notes.js

1 new commit added

  • Fetch Release Issues JSON From Chosen Stream

1 new commit added

  • Small issues

2 new commits added

  • Add issues and links to issues in release notes
  • Add indentation for coreos-release-notes.js

@siosm

LGTM. Is this fetching all streams at once? Could we fetch only the stream we need as required?

It now fetches from the single specified stream :thumbsup:

@lucab

Two minor suggestions:
- Could you exclude the dots ('*') from the link anchor for each issue to make it more easier to read?
- If there are no issues for a given release, could we not display the 'Issues fixes' text?

Thanks!

Metadata Update from @thunderbirdtr:
- Request assigned

1 new commit added

  • Add functionality to make title appear if release issues exists

1 new commit added

  • Small changes removing function

2 new commits added

  • Add issues and links to issues in release notes
  • Add indentation for coreos-release-notes.js

1 new commit added

  • Small changes adding new function

2 new commits added

  • Add issues and links to issues in release notes
  • Add indentation for coreos-release-notes.js

1 new commit added

  • Bug fixes

2 new commits added

  • Add issues and links to issues in release notes
  • Add indentation for coreos-release-notes.js

@thunderbirdtr Could you have a look at this and possibly merge it? Thanks.

LGTM to me. @siosm could you do one more final check then I'll merge it.

if (releasesJson.hasOwnProperty(build.id)) {

It looks like you do this check once for the switch case and then once again below. One should be enough?

I think we should have the following:
- if the build id does not exists in the JSON, then add something like "Releases notes for this release are still pending review"
- If the build id exists in the JSON but the list is empty, then display: " No specific issues fixed in this release".
- If the build id exists and there are issues then we list them.

cc @dustymabe @jlebon WDYT about this? I can re-add the missing empty buildids to the notes.


  • Could you exclude the dots ('*') from the link anchor for each issue to make it more easier to read?

Sorry, maybe this was ambiguous. Could we make this a proper HTML list with entries so that they get their own "dots" but not as part of the link?

+                          let releaseNotesLinkAndText = h('a', { attrs: { href: specificIssue[i].url }, }, specificIssue[i].text);            
                    +                          releaseNotesElements.push(releaseNotesLinkAndText);            
                    +                          releaseNotesElements.push(h('br'));

// TODO: naive implementation is a list of subjects under each component header            
// in the future add buttons for detailed information of each note item

I'd prefer we track future improvement in the parent issue as TODOs in the code here will be forgotten.

1 new commit added

  • Added lists to release note issues

This will likely never be reached given that we have the same initial check in 189

I don't think we need this one anymore. It looks more compact without it.

In this case, we have three options: the non-existing path, the existing & empty one, and the existing and not empty one. I think it will be easier to check for existence first, then if the list is empty.

2 new commits added

  • Add issues and links to issues in release notes
  • Add indentation for coreos-release-notes.js

Minor nit: We're losing this comment here. Maybe it should we re-added below the code added here.

I think you probably need an else branch here now. Unfortunately we don't have an example to try this one out.

Minor nit: Let's keep this empty line above the comment

https://github.com/coreos/fedora-coreos-streams/pull/516 will give us updated data to test

2 new commits added

  • Add issues and links to issues in release notes
  • Add indentation for coreos-release-notes.js

2 new commits added

  • Add issues and links to issues in release notes
  • Add indentation for coreos-release-notes.js

2 new commits added

  • Add issues and links to issues in release notes
  • Add indentation for coreos-release-notes.js

2 new commits added

  • Add issues and links to issues in release notes
  • Add indentation for coreos-release-notes.js

This looks great to me! Thanks a lot! Let's merge this @thunderbirdtr please! :)

Pull-Request has been merged by thunderbirdtr

@siosm @meltayeb thank you guys !!

Merge complete

Metadata