Skip to content

Commit

Permalink
PLATUI-2972 documentation updates
Browse files Browse the repository at this point in the history
  • Loading branch information
ellamdav committed Apr 24, 2024
1 parent 72d04dd commit c16ed7d
Show file tree
Hide file tree
Showing 2 changed files with 18 additions and 5 deletions.
12 changes: 12 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,18 @@ and this project adheres to [Semantic Versioning](http://semver.org/).
For compatibility information see `govukFrontendVersion` and `hmrcFrontendVersion` in
[LibDependencies](project/LibDependencies.scala)

## [9.10.0] - 2024-04-24

### Changed

- Added meta-tests to ensure fixture-driven unit tests and Scalacheck-driven integration tests cover all components
- Fixed up existing gaps in coverage highlighted by these new tests

### Compatible with

- [hmrc/hmrc-frontend v6.17.0](https://github.com/hmrc/hmrc-frontend/releases/tag/v6.17.0)
- [alphagov/govuk-frontend v5.3.0](https://github.com/alphagov/govuk-frontend/releases/tag/v5.3.0)

## [9.9.0] - 2024-04-24

### Changed
Expand Down
11 changes: 6 additions & 5 deletions docs/maintainers/upgrading.md
Original file line number Diff line number Diff line change
Expand Up @@ -126,14 +126,15 @@ index 51d2d346..713db75d 100644
### Comparing forked components in other repos
As noted above, some of our `play-frontend-hmrc` components are not direct ports, but are manually created and need to be kept manually aligned with `govuk-frontend` in particular.

For example, if there are changs to the `GovukCookieBanner` template or styles, these should be compared against the cookie banner in `tracking-consent-frontend` (see [banner.ts](https://github.com/hmrc/tracking-consent-frontend/blob/main/js/src/ui/banner.ts)).
For example, if there are changes to the `GovukCookieBanner` template or styles, these should be compared against the cookie banner in `tracking-consent-frontend` (see [banner.ts](https://github.com/hmrc/tracking-consent-frontend/blob/main/js/src/ui/banner.ts)).

#### Adding New Components
When running the above steps, there will be test failures if existing components have changed. However, there will be no
failures for new components which have been added to `hmrc-frontend` or `govuk-frontend` but which have not yet been implemented in
`play-frontend-hmrc`.
When running the above steps, there will be test failures if existing components have changed.
Any new components which have been added to `hmrc-frontend` or `govuk-frontend` but which have not yet been implemented in
`play-frontend-hmrc` should also get flagged by the [TemplateUnitBaseMetaSpec](play-frontend-hmrc-play-30/src/test/scala/uk/gov/hmrc/helpers/views/TemplateUnitBaseMetaSpec.scala)-
and [TemplateIntegrationBaseMetaSpec](it-play-30/src/test/scala/uk/gov/hmrc/support/TemplateIntegrationBaseMetaSpec.scala)-derived meta-tests for each underlying library.

Therefore, it is important to look at the diffs between versions of `govuk-frontend`, and read the CHANGELOG.
That said, it is still important to look at the diffs between versions of `govuk-frontend`, and read the CHANGELOG.

To add a new component:
- Add the view model as a Scala case class in the folder: `src/main/scala/uk/gov/hmrc/(hmrc|govuk)frontend/views/viewmodels`
Expand Down

0 comments on commit c16ed7d

Please sign in to comment.