Idempotent operations for reading, checkout branch prior to writing #47
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
…nch prior to doing work
We should test for the CHANGELOG.md file in the release branch in an
idempotent way; we can use the exit code of `git show
{REF}:CHANGELOG.md` for this.
When we want to change the changelog file, we need to switch to the
associated release branch first.
Signed-off-by: Matthew Weier O'Phinney <matthew@weierophinney.net>
Updates `CreateReleaseTextViaKeepAChangelog` to use `git show
{ref}:CHANGELOG.md` to to test for the existence of the file, as well as
to fetch its contents, making the operation idempotent.
Signed-off-by: Matthew Weier O'Phinney <matthew@weierophinney.net>
I was reproducing the same code a ton; time to extract it. Signed-off-by: Matthew Weier O'Phinney <matthew@weierophinney.net>
…elog file on a branch Signed-off-by: Matthew Weier O'Phinney <matthew@weierophinney.net>
Prevents env issues during CI. Signed-off-by: Matthew Weier O'Phinney <matthew@weierophinney.net>
|
@Ocramius all yours to review. :) |
Details fix for changelog operations. Signed-off-by: Matthew Weier O'Phinney <matthew@weierophinney.net>
Ocramius
reviewed
Aug 12, 2020
| use Webmozart\Assert\Assert; | ||
|
|
||
| use function file_exists; | ||
| use function file_get_contents; |
There was a problem hiding this comment.
I like that these filesystem access operations went away from here 👍
Ocramius
approved these changes
Aug 12, 2020
weierophinney
commented
Aug 12, 2020
| string $repositoryDirectory | ||
| ): bool { | ||
| $process = new Process(['git', 'show', $sourceBranch->name() . ':CHANGELOG.md'], $repositoryDirectory); | ||
| $process->run(); |
There was a problem hiding this comment.
Very specifically not "mustRun()" here, as failure is an expected status.
weierophinney
added a commit
that referenced
this pull request
Aug 12, 2020
Details fix for changelog operations. Signed-off-by: Matthew Weier O'Phinney <matthew@weierophinney.net>
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 patch does the following:
Adds the interface
ChangelogExists, with one implementation,ChangelogExistsViaConsole. The functionality is intended to be used whenever we want to check for existence of a changelog on a given branch, and is idempotent (it uses the exit code ofgit show {REF}:CHANGELOG.mdto determine existence).Any operation that needs to check for existence of the changelog now composes an instance of
ChangelogExistsfor that purpose.Operations that only read the
CHANGELOG.mdnow do so usinggit show {REF}:CHANGELOG.md.This change was introduced toCreateReleaseTextViaKeepAChangelog.Any operation that will write to the CHANGELOG.md now first uses
ChangelogExiststo test for the file, and then performs aCheckoutBranchoperation to ensure that the correct version is updated, and to ensure we push back to the correct branch. Specifically, I updatedCreateReleaseTextViaKeepAChangelogto compose aCheckoutBranchinstance for use after determining changes can be made.This should resolve all remaining issues regarding updates to the changelog file.