Update note about confirmation emails in publishing workflow docs #1341
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
JPrevost
reviewed
Aug 14, 2024
README.md
Outdated
| # wait for all ETD emails to be received (the preservation email is the final one to look for) | ||
| # scale the worker back down so we do not pay for more CPU/memory than we need | ||
| # wait for all ETD emails to be received (there are three emails: one overall results summary, one preservation | ||
| # results summary, and one MARC batch export. The batch export email is typically the final one to look for). |
There was a problem hiding this comment.
I'm glad you are updating these docs as I noted the last time I ran them there was a discrepancy but wasn't sure if it was going to be predictive. It seems like it is. That said, would you be okay with removing the bit that says which one is last and just introducing this new change that list what the 3 are? i.e,. just removing The batch export email is typically the final one to look for and leaving the rest of this change?
There was a problem hiding this comment.
If you want to keep that in I'm fine with it though as it does seem to have been stable over the last several runs.
There was a problem hiding this comment.
Yeah, that works for me.
JPrevost
approved these changes
Aug 14, 2024
Why these changes are being introduced: The readme indicates that the last email to look for while running the publication workflow is the preservation email. The past few times I've run the job, it's been the MARC export email. Relevant ticket(s): N/A How this addresses that need: This generalizes the aforementioned note to check for the presence of all three emails, before suggesting that the MARC email may be the last one in the series. Side effects of this change: None.
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.
Why these changes are being introduced:
The readme indicates that the last email to look for while running the publication workflow is the preservation email. The past few times I've run the job, it's been the MARC export email.
Relevant ticket(s):
N/A
How this addresses that need:
This generalizes the aforementioned note to check for the presence of all three emails, before suggesting that the MARC email may be the last one in the series.
Side effects of this change:
None.
Developer
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)
Code Reviewer
(not just this pull request message)
Requires database migrations?
NO
Includes new or updated dependencies?
NO