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

Create release notes for package lock-related release of GOV.UK Prototype Kit #1152

Closed
5 tasks done
EoinShaughnessy opened this issue Nov 11, 2021 · 4 comments · Fixed by #1162
Closed
5 tasks done
Assignees

Comments

@EoinShaughnessy
Copy link
Contributor

EoinShaughnessy commented Nov 11, 2021

What

Create release notes for package lock-related release of GOV.UK Prototype Kit.

Why

We need to tell users about a fix we're introducing that will hopefully clear up the security issues we've been asking them to fix recently.

We also need to emphasise to users:

  • that they should upgrade to this new version of the Kit
  • why this upgrade is so important for them to make
  • that we'll help them if they have any difficulty upgrading

Who needs to work on this

Developers, technical writer

Who needs to review this

Two technical writers (one for pre-i, one for 2i)

Done when

  • We decide whether this is a 'breaking' or 'feature' release
  • Release notes drafted
  • Draft passes pre-i
  • Draft passes 2i
  • Draft published
@EoinShaughnessy
Copy link
Contributor Author

@joelanman @lfdebrux Here's the first pass at release notes: https://docs.google.com/document/d/1eIGu4esdk9u8rQh1DS7XL6MSTeyqJrViecwEwZy4yFU/edit

Please advise on tone and let me know what else we might need to add (like details about the lockfileversions). :)

@domoscargin domoscargin linked a pull request Nov 15, 2021 that will close this issue
@EoinShaughnessy
Copy link
Contributor Author

@joelanman Do we need to link a PR to this issue?

@domoscargin
Copy link
Contributor

I've linked the V11 release PR to this issue as that includes the CHANGELOG updates.

@EoinShaughnessy
Copy link
Contributor Author

@domoscargin Nice! Thank you.

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 a pull request may close this issue.

2 participants