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.16k stars 319 forks source link

Running the pre-release script from a fork produces an incorrect install command #2109

Closed hannalaakso closed 3 years ago

hannalaakso commented 3 years ago

What

Our pre-release script pushes up a branch which can be used in place of the Frontend npm package to trial changes in other repos. In my testing the script can be run from a fork (which is something an external contributor might want to do) and the branch is pushed to the fork.

The problem is that the install command produced by the script is incorrect as it hardcodes the org and repo name in:

To install the pushed branch release run 'npm install --save alphagov/govuk-frontend#78b51333

We could investigate if it's possible to detect the name of a fork and replace it in the above command that is outputted. I did a really quick bit of investigation and didn't see an obvious way of doing this.

However we should firstly decide if this is something we want to support.

Why

Supporting external contributors to run the pre-release script from a fork would allow them to run the script themselves when they make a change, instead of requesting our team to do this when there is a change.

Who needs to know about this

Developer, technical writer

Done when

Done when - see above

hannalaakso commented 3 years ago

Following a team discussion, we decided that right now we're comfortable with asking external contributors to contact us to create pre-releases (which is what our documentation already states). However, if we get sufficient evidence to show that we should make it possible for contributors to do this themselves we can re-open this issue.

We also still have a card to make the relevant documentation more visible to external contributors by including it in the Community section of the Design System: https://github.com/alphagov/govuk-design-system/issues/1425