search

alphagov / govuk-prototype-kit

Rapidly create HTML prototypes of GOV.UK services
https://prototype-kit.service.gov.uk
MIT License
305 stars 236 forks source link

Publish Step by Step as an npm package #1380

Closed joelanman closed 2 years ago

joelanman commented 2 years ago

What

Publish Step by Step as an npm package

Why

This is the simplest way to let people stay on the old version if they need to - they can use v1 of the package

Who needs to work on this

Developers

Who needs to review this

Developers

Done when

lfdebrux commented 2 years ago

We'll probably want to create a new npm account for this. For now we should keep any credentials in the design system team credentials store, although we should probably get out own place to keep credentials soon. I think publishing manually should be fine, I don't anticipate that we'll be publishing often enough to need a continuous deployment setup.

Regarding what the package should be named, I was wondering if we wanted to use a scope for this and other prototype kit packages? So it would be something like @govuk-prototype-kit/step-by-step. Some large Node projects use the scope (the @ part) to group related packages together), although other projects just make sure to include the name of the project at the start of the package name (so in this case it would just be govuk-prototype-kit-step-by-step.

Izabela-16 commented 2 years ago

@natcarey to write up about the jQuery

lfdebrux commented 2 years ago

@natcarey has booked in a meeting with the team tomorrow (Wednesday) to confirm the org name (we're leaning @govuk-prototype).

nataliecarey commented 2 years ago

The outcome from our meeting was to use the following names (shown as examples of how users might interact with them):

npm install govuk-prototype-kit

npm install @govuk-prototype-kit/step-by-step

What this means is that we need to create:

A user called govuk-prototype-kit (and figure out sharing the credentials among the team) An organisation called govuk-prototype-kit - this means that everything that starts with @govuk-prototype-kit/ is ours and we can create what we want in that space A module called govuk-prototype-kit which will be the actual kit

This approach allows our users to tell the difference between 'official' extensions and 'community' extensions based on the install command they are asked to use.

lfdebrux commented 2 years ago

We've created the npm user govuk-prototoype-kit, associated with the prototype kit team email address.