Add how-to document for applying Pantheon updates #137
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
** Why are these changes being introduced: * The process of applying upstream changes made by Pantheon to their platform has proven to be somewhat complex through the first three rounds of updates. We need a how-to document to help us follow a consistent workflow. ** Relevant ticket(s): * https://mitlibraries.atlassian.net/browse/pw-49 ** How does this address that need: * This writes out the steps I've been following, particularly for the last two rounds of updates. This is the starting point for this work, as I'm not certain that I've found a reasonably simple workflow. ** Document any side effects to this change: * None - this is a documentation-only change.
jazairi
approved these changes
Jul 13, 2023
There was a problem hiding this comment.
This is so clearly written that it makes sense even to me, someone who doesn't understand WP or Pantheon. Well done, and thank you! :) These instructions make sense, and I think I could deploy dependency updates using them. (Incidentally, I see now why we use the default# convention, since we retain the default branch in our repo.)
I have two comments, both non-blocking:
- Step 8 says to merge
catchupintomaster"after any needed signoffs and review." Could we clarify what this means? Do we want code review before that merge, or QA from stakeholders? Maybe it's a case-by-case thing? - I'd prefer to use backticks for branch names throughout, for consistency's sake (they are sometimes enclosed in double quotes).
|
Thanks for that feedback - I think the document looks a bit better now that I've tweaked those aspects. Hopefully I've caught all the backticks this time... |
|
@matt-bernhardt Yep, looks great. Thanks for addressing both comments! |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This writes out the steps I've been following, particularly for the last two rounds of updates. This is the starting point for this work, as I'm not certain that I've found a reasonably simple workflow.
The ticket for the last round of updates, which helped define this process, was https://mitlibraries.atlassian.net/browse/pw-49
Developer
Stylesheets
string incremented.
Secrets
Documentation
Accessibility
our guide and
all issues introduced by these changes have been resolved or opened as new
issues (link to those issues in the Pull Request details above)
Stakeholder approval
Dependencies
NO dependencies are updated
Code Reviewer
(not just this pull request message)