Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs(PPDSC-2204): release notes #319

Merged
merged 24 commits into from
Aug 9, 2022
Merged

Conversation

mstuartf
Copy link
Contributor

PPDSC-2204

What

  1. Background - provide info on our releases
  2. What did you do - added a release notes page
  3. What does the reviewers should expect - release notes page matching spec

I have done:

  • Written unit tests against changes
  • Written functional tests against the component and/or NewsKit site
  • Updated relevant documentation

I have tested manually:

  • The feature's functionality is working as expected on Chrome, Firefox, Safari and Edge
  • The screen reader reads and flows through the elements as expected.
  • There are no new errors in the browser console coming from this PR.
  • When visual test is not added, it renders correctly on different browsers and mobile viewports (Safari, Firefox, small mobile viewport, tablet)
  • The Playground feature is working as expected

Before:

After:

Who should review this PR:

How to test:

mstuartf added 8 commits July 28, 2022 16:57
- Fetch release notes markdown from github api
- Parse markdown for display
- Remove comments and invalid link structures
- Add hyperlinks to tickets, PRs, profiles and release comparisons
- Infer release type by comparing semver against previous release
@mstuartf mstuartf added the ready for design review Please assist in getting this reviewed label Jul 29, 2022
@github-actions github-actions bot added the docs Improvements or additions to documentation label Jul 29, 2022
@newskit-engineering
Copy link
Collaborator

@mstuartf mstuartf added ready for review Please assist in getting this reviewed and removed ready for design review Please assist in getting this reviewed labels Aug 8, 2022
// release removed above.
change_level:
next.tag_name === 'v5.4.2' // todo: remove this (only here for design review)
? 'major'
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

does this todo still need to be here?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ah yes, I added that so there was a major release for design review. Will remove.

@baburay23 baburay23 self-requested a review August 9, 2022 08:22
@mstuartf mstuartf merged commit d69ffbd into main Aug 9, 2022
@mstuartf mstuartf deleted the docs/PPDSC-2204-release-notes branch August 9, 2022 09:52
Xin00163 pushed a commit that referenced this pull request Oct 17, 2022
* docs(PPDSC-2204): add release notes page

- Fetch release notes markdown from github api
- Parse markdown for display
- Remove comments and invalid link structures
- Add hyperlinks to tickets, PRs, profiles and release comparisons
- Infer release type by comparing semver against previous release

* docs(PPDSC-2204): temporarily show a major release for review

* docs(PPDSC-2204): fix github profile links

* docs(PPDSC-2204): format date

* docs(PPDSC-2204): add need help card

* docs(PPDSC-2204): format notes typography

* docs(PPDSC-2204): add github link

* docs(PPDSC-2204): use page template

* docs(PPDSC-2204): restructure so build passes

* docs(PPDSC-2204): component tests added

* docs(PPDSC-2204): restructure dirs

* docs(PPDSC-2204): api call tests

* docs(PPDSC-2204): markdown text colour

* docs(PPDSC-2204): tidy up markdown

* docs(PPDSC-2204): add margin between header and notes

* docs(PPDSC-2204): replace anchors for link components

* docs(PPDSC-2204): format links correctly

* docs(PPDSC-2204): correct badge colours

* docs(PPDSC-2204): update badge colours

* docs(PPDSC-2204): update icon import

* docs(PPDSC-2204): remove fake major release

* docs(PPDSC-2204): update final release info
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Improvements or additions to documentation ready for review Please assist in getting this reviewed
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants