alphagov / govuk-frontend

GOV.UK Frontend contains the code you need to start building a user interface for government platforms and services.
https://frontend.design-system.service.gov.uk/
MIT License
1.17k stars 320 forks source link

Investigate need for a separate build to provide a release Zip on GitHub #5145

Open romaricpascal opened 2 months ago

romaricpascal commented 2 months ago

What

Investigate whether it's worth building a separate dist folder to upload to GitHub or if we could provide the built files for each release a different way (eg. uploading the package uploaded to npm).

It's worth noting that beyond the complexity, the dist folder also gets a diff commented on the PRs that have changes to dist. This allows us to review that no unexpected code gets bundled in GOV.UK Frontend, so we'll need to make sure we can keep doing so.

Why

Having a separate Zip file uploaded to GitHub means we're maintaining a separate build process for creating it. This expands the possibility for breakage, in order to produce something that's not meant for use in production as we explicitely state in our documentation.

In addition, since #4240, the package contains all the files that are shipped in dist: both the minified CSS and JS and the assets. This brings to question whether we need to make a full build to create dist.

Who needs to work on this

Developers

Who needs to review this

Developers

Done when