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

CRDCDH-1612 Release Notes Page #474

Merged
merged 16 commits into from
Oct 1, 2024
Merged

CRDCDH-1612 Release Notes Page #474

merged 16 commits into from
Oct 1, 2024

Conversation

amattu2
Copy link
Member

@amattu2 amattu2 commented Sep 24, 2024

Overview

This PR primarily adds a dynamically-fetched Release Notes page from our CHANGELOG.md document. In order to ensure each release/tier reflects accurate release notes, we fetch the CHANGELOG.md from GitHub based on the Build Tag (REACT_APP_FE_VERSION variable).

Additionally, it introduces a debug logging wrapper, which can be used to safely output errors to the console. This wrapper intentionally does not emit output during testing to prevent test failures. While this wrapper currently just outputs to the console, it can be expanded in the future to send logs to an external collector.

Note

In order to test this locally, define the ENV variable REACT_APP_FE_VERSION as 3.1.0.410 (or later), which is the first build with release notes.

Change Details (Specifics)

(Related to requirements)

  • Create a dynamically-fetched Release Notes page using react-markdown
    • Right now this page has no official UX design, TBD on how the markdown document is formatted. Will adjust based on that

(Supporting changes)

  • Add a Logger wrapper instead of using direct console.xxx functions
    • Re-enable ESLint warning for console.error (to force logging wrapper usage instead)
  • Rename globalHeaderData.tsx -> HeaderConfig.ts and globalFooterData.tsx -> FooterConfig.ts
    • Neither of these contain JSX anymore so I dropped the x
  • Add loose-typing to the FooterConfig
  • Update the Footer implementations (desktop, tablet, mobile) to support localized links
  • Add missing Open Sans font-weights 400, 600, and 700 for the Footer

Related Ticket(s)

CRDCDH-1612 (This FE task)
CRDCDH-1615 (Markdown Document Task)
CRDCDH-1532 (User Story)

@amattu2 amattu2 added this to the 3.1.0 (PMVP-M2) milestone Sep 24, 2024
@amattu2 amattu2 added the 🚧 Do Not Merge This PR is not ready for merging label Sep 24, 2024
@coveralls
Copy link
Collaborator

coveralls commented Sep 24, 2024

Pull Request Test Coverage Report for Build 11059991612

Details

  • 70 of 81 (86.42%) changed or added relevant lines in 11 files are covered.
  • 3 unchanged lines in 2 files lost coverage.
  • Overall coverage increased (+0.5%) to 48.043%

Changes Missing Coverage Covered Lines Changed/Added Lines %
src/content/ReleaseNotes/Controller.tsx 21 22 95.45%
src/hooks/useBuildReduxStore.ts 0 1 0.0%
src/router.tsx 0 1 0.0%
src/components/Footer/FooterTablet.tsx 0 3 0.0%
src/components/Footer/FooterMobile.tsx 0 5 0.0%
Files with Coverage Reduction New Missed Lines %
src/components/Footer/FooterTablet.tsx 1 13.64%
src/components/Footer/FooterMobile.tsx 2 11.54%
Totals Coverage Status
Change from base Build 11056896265: 0.5%
Covered Lines: 2864
Relevant Lines: 5418

💛 - Coveralls

@amattu2 amattu2 marked this pull request as ready for review September 26, 2024 20:56
@amattu2 amattu2 removed the 🚧 Do Not Merge This PR is not ready for merging label Sep 26, 2024
Alejandro-Vega
Alejandro-Vega previously approved these changes Oct 1, 2024
Copy link
Collaborator

@Alejandro-Vega Alejandro-Vega left a comment

Choose a reason for hiding this comment

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

Everything looks super solid to me! Great job! I just commented two questions I had and one suggestion. Feel free to disregard all comments if you feel otherwise.

src/utils/fetchUtils.ts Outdated Show resolved Hide resolved
src/utils/logger.ts Outdated Show resolved Hide resolved
src/utils/envUtils.ts Show resolved Hide resolved
@Alejandro-Vega Alejandro-Vega added the 📝 Change Requested This PR has requested changes label Oct 1, 2024
@amattu2 amattu2 removed the 📝 Change Requested This PR has requested changes label Oct 1, 2024
Copy link
Collaborator

@Alejandro-Vega Alejandro-Vega left a comment

Choose a reason for hiding this comment

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

LGTM!

@Alejandro-Vega Alejandro-Vega merged commit 9b3e6ff into 3.1.0 Oct 1, 2024
5 checks passed
@Alejandro-Vega Alejandro-Vega deleted the CRDCDH-1612 branch October 1, 2024 19:12
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants