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 docs on how we use support branches #21

Merged
merged 1 commit into from
Aug 25, 2023
Merged

Conversation

36degrees
Copy link
Contributor

Add some docs to illustrate how we can use support branches, building on top of our existing docs on releasing from a support branch.

I've added some illustrations using Mermaid and the very useful Git graph diagram style. There's potential to properly embed it (see alphagov/tech-docs-gem#184) but I figured we should wait and see how useful they are first / how often we use them.

@36degrees
Copy link
Contributor Author

Raising early to get feedback – still need to work out how this replaces or interacts with the existing guidance on releasing from a support branch.

@domoscargin domoscargin self-requested a review June 5, 2023 09:08
@36degrees 36degrees force-pushed the version-control-basics branch from 2483554 to 67b8e6b Compare June 9, 2023 16:28
Base automatically changed from version-control-basics to main June 9, 2023 16:29
@netlify
Copy link

netlify bot commented Jun 9, 2023

Deploy Preview for govuk-design-system-team-docs ready!

Name Link
🔨 Latest commit 58bf69a
🔍 Latest deploy log https://app.netlify.com/sites/govuk-design-system-team-docs/deploys/64dcd2de8e3e300008845cec
😎 Deploy Preview https://deploy-preview-21--govuk-design-system-team-docs.netlify.app/how-we-work/version-control/support-branches
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

@owenatgov owenatgov self-assigned this Jun 30, 2023
Copy link
Contributor

@owenatgov owenatgov left a comment

Choose a reason for hiding this comment

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

Looks good so far. Made a few pithy content changes, not gonna die for them if you think they're inaccurate.

@36degrees
Copy link
Contributor Author

As discussed in dev catch up, we should also add:

  • how required status checks are configured for support branches
  • to follow the release instructions from the support branch rather than the release instructions from main

@36degrees 36degrees marked this pull request as ready for review August 1, 2023 13:59
36degrees added a commit to alphagov/govuk-frontend that referenced this pull request Aug 1, 2023
The process for using a support branch is being moved into our team docs as part of alphagov/design-system-team-docs#21.

Remove the existing documentation and add a reference to it in our standard docs on publishing releases.
@owenatgov owenatgov removed their assignment Aug 2, 2023
@36degrees 36degrees force-pushed the support-branches branch 2 times, most recently from 822d160 to 1aca28c Compare August 7, 2023 15:52
@36degrees 36degrees requested a review from owenatgov August 8, 2023 14:54
Copy link
Contributor

@owenatgov owenatgov left a comment

Choose a reason for hiding this comment

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

One last comment. We're very close, looking tidy.

Copy link
Contributor

@owenatgov owenatgov left a comment

Choose a reason for hiding this comment

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

💪🏻

@36degrees 36degrees merged commit 19bb04b into main Aug 25, 2023
@36degrees 36degrees deleted the support-branches branch August 25, 2023 09:05
36degrees added a commit to alphagov/govuk-frontend that referenced this pull request Sep 20, 2023
The process for using a support branch is being moved into our team docs as part of alphagov/design-system-team-docs#21.

Remove the existing documentation and add a reference to it in our docs on publishing releases. Update those docs to reflect the fact that this branch is a support branch.
36degrees added a commit to alphagov/govuk-frontend that referenced this pull request Sep 20, 2023
We’re adding docs on using support branches to our team docs as part of alphagov/design-system-team-docs#21.

Update our release docs for v3.x to reflect the fact that this branch is a support branch and to link to the new docs.
36degrees added a commit to alphagov/govuk-frontend that referenced this pull request Sep 20, 2023
The process for using a support branch is being moved into our team docs as part of alphagov/design-system-team-docs#21.

Remove the existing documentation and add a reference to it in our standard docs on publishing releases.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Development

Successfully merging this pull request may close these issues.

2 participants