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

Add documentation for releasing GOV.UK Frontend from a support branch #2415

Merged
merged 1 commit into from
Nov 11, 2021

Conversation

vanitabarrett
Copy link
Contributor

Closes #1958

Documentation for releasing a patch fix (e.g: urgent or security fix) when there are unreleased changes on main that can't go out yet. This process was trialled for the 3.14.0 release in an artificial scenario (in reality, we'd likely only follow this process for patch fixes)

@vanitabarrett vanitabarrett added the documentation User requests new documentation or improvements to existing documentation label Nov 1, 2021
@govuk-design-system-ci govuk-design-system-ci temporarily deployed to govuk-frontend-pr-2415 November 1, 2021 10:57 Inactive
@vanitabarrett vanitabarrett requested review from a team and EoinShaughnessy November 1, 2021 10:57
@vanitabarrett
Copy link
Contributor Author

@EoinShaughnessy Does this need to go through pre-i/2i?

Copy link
Member

@lfdebrux lfdebrux left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

These links can be relative

@vanitabarrett vanitabarrett force-pushed the publishing-from-support-branch branch from 9c97fee to f1e62d7 Compare November 4, 2021 11:32
@govuk-design-system-ci govuk-design-system-ci temporarily deployed to govuk-frontend-pr-2415 November 4, 2021 11:32 Inactive
@vanitabarrett vanitabarrett force-pushed the publishing-from-support-branch branch from f1e62d7 to 3ce7af9 Compare November 4, 2021 12:01
@govuk-design-system-ci govuk-design-system-ci temporarily deployed to govuk-frontend-pr-2415 November 4, 2021 12:01 Inactive
Copy link
Member

@lfdebrux lfdebrux left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

A couple of extra snags:

Copy link
Member

@lfdebrux lfdebrux left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Apart from the issues above, this looks good to me 👍

Thank you for organising this and putting it together 🙌

@vanitabarrett vanitabarrett force-pushed the publishing-from-support-branch branch from 3ce7af9 to cbfea16 Compare November 5, 2021 10:38
@govuk-design-system-ci govuk-design-system-ci temporarily deployed to govuk-frontend-pr-2415 November 5, 2021 10:39 Inactive
@EoinShaughnessy
Copy link
Contributor

@vanitabarrett Yeah, this should probably go through pre-i and 2i. Even if we're the ones using it, it might yet reach eyes outside of the team (like if we ever surface it in the Tech Docs Template). If that sounds ok, I'll ask for pre-i/2i.

@vanitabarrett
Copy link
Contributor Author

Sounds good to me, thanks @EoinShaughnessy !

@EoinShaughnessy
Copy link
Contributor

Have sent content for pre-i.

@EoinShaughnessy EoinShaughnessy self-assigned this Nov 8, 2021
@EoinShaughnessy EoinShaughnessy removed their request for review November 8, 2021 17:50
Copy link
Contributor

@EoinShaughnessy EoinShaughnessy left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@vanitabarrett If you un-assign me as a reviewer, will that allow me to commit suggestions into the doc?

Copy link
Contributor

@seaemsi seaemsi left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Have suggested a few small changes and made some comments.

@govuk-design-system-ci govuk-design-system-ci temporarily deployed to govuk-frontend-pr-2415 November 9, 2021 17:43 Inactive
@govuk-design-system-ci govuk-design-system-ci temporarily deployed to govuk-frontend-pr-2415 November 11, 2021 08:03 Inactive
@govuk-design-system-ci govuk-design-system-ci temporarily deployed to govuk-frontend-pr-2415 November 11, 2021 08:04 Inactive
@EoinShaughnessy EoinShaughnessy force-pushed the publishing-from-support-branch branch from 4bc9fc8 to 37c5298 Compare November 11, 2021 08:05
@govuk-design-system-ci govuk-design-system-ci temporarily deployed to govuk-frontend-pr-2415 November 11, 2021 08:06 Inactive
@govuk-design-system-ci govuk-design-system-ci temporarily deployed to govuk-frontend-pr-2415 November 11, 2021 15:31 Inactive
@EoinShaughnessy EoinShaughnessy force-pushed the publishing-from-support-branch branch from 6ea116c to 98c5ed2 Compare November 11, 2021 15:33
@govuk-design-system-ci govuk-design-system-ci temporarily deployed to govuk-frontend-pr-2415 November 11, 2021 15:33 Inactive
@EoinShaughnessy
Copy link
Contributor

@vanitabarrett Doc has passed 2i. Before we merge this - should the doc title match the filename? Currently, the doc title (i.e., displayed at the top of the doc) is 'Publish GOV.UK Frontend when main branch has unreleasable changes', and the filename is 'publishing-from-a-support-branch.md'.

@vanitabarrett
Copy link
Contributor Author

Thanks @EoinShaughnessy ! Yeah I wasn't too sure on the best filename for this to be honest. Trying to make "Publish GOV.UK Frontend when main branch has unreleasable changes" into a filename seemed a bit difficult 😅

@govuk-design-system-ci govuk-design-system-ci temporarily deployed to govuk-frontend-pr-2415 November 11, 2021 16:10 Inactive
@EoinShaughnessy
Copy link
Contributor

@vanitabarrett Ha, yeah tricky alright! Have changed doc title to match filename. Hope that's ok. Did this because:

  • those 2 things should match ideally
  • it means a less verbose title
  • it mirrors the approach of other doc titles ('Publishing', 'Testing and linting') in the same folder
  • the first line of the doc basically reiterated the previous title - "This document is for GOV.UK Design System developers who need to publish a support branch of GOV.UK Frontend when the main branch contains unreleasable changes."

@EoinShaughnessy EoinShaughnessy force-pushed the publishing-from-support-branch branch from b21d4aa to b3ac1e0 Compare November 11, 2021 16:15
@govuk-design-system-ci govuk-design-system-ci temporarily deployed to govuk-frontend-pr-2415 November 11, 2021 16:15 Inactive
@vanitabarrett
Copy link
Contributor Author

Thanks @EoinShaughnessy , seems sensible. Do you think we still need that second heading 'publish GOV.UK Frontend from a support branch' in that case?

@govuk-design-system-ci govuk-design-system-ci temporarily deployed to govuk-frontend-pr-2415 November 11, 2021 16:41 Inactive
@EoinShaughnessy
Copy link
Contributor

@vanitabarrett You're right, that heading can go. I've deleted it and made the headings after it into either H2s (if they were H3s before) or H3s (if they were H4s before).

Closes #1958

Documentation for releasing a patch fix (e.g: urgent or security fix)
when there are unreleased changes on `main` that can't go out yet.
@EoinShaughnessy EoinShaughnessy force-pushed the publishing-from-support-branch branch from 6149e25 to 3a1b813 Compare November 11, 2021 16:50
@govuk-design-system-ci govuk-design-system-ci temporarily deployed to govuk-frontend-pr-2415 November 11, 2021 16:50 Inactive
@vanitabarrett vanitabarrett merged commit f281cd2 into main Nov 11, 2021
@vanitabarrett vanitabarrett deleted the publishing-from-support-branch branch November 11, 2021 16:59
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation User requests new documentation or improvements to existing documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Decide and document how to release a patch fix for GOV.UK Frontend if there are unreleased changes on main
6 participants