Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Resolve simultaneous deployments with rebase (#1054)
* Return early from dry run Determining whether to create a merge commit would elicit a nested conditional, which could be hard to parse for a human reader. This is avoided by returning early as soon as possible for a dry run. This also resolves the erroneous 'changes committed' message when no changes were actually committed because of the dry run. A message specific to dry-run is logged instead. * Add force parameter to action interface Existing behaviour is equivalent to force=true, so the default value is true. * Implement pull+rebase procedure * Declare force parameter in action * Detect both rejection syntaxes * Return both stdout and stderr from execute * Ignore non-zero exit status on push * Remove unnecessary error catch * Fetch and rebase in separate steps * Explicitly bind incoming branch I think the fetch will update the origin/gh-pages branch but not the gh-pages branch, despite requesting gh-pages. This means that when I later attempt to rebase the temp branch on top of the gh-pages branch, there will be nothing to do, because that's already where it is. * Implement attempt limit I don't expect this to ever require more than one attempt in production, but in theory it's possible that this procedure could loop forever. We would need to keep fetching and rebasing if changes keep being added to the remote. In practice, I believe this would only happen if there are lots of workflows simultaneously deploying to the same branch, all using this action. In this case only one would be able to secure a lock at a time, leading to the total number of attempts being equal to the number of simultaneous deployments, assuming each deployment makes each attempt at the exact same time. The limit may need to be increased or even be configurable, but 3 should cover most uses. * Update tests for execute output split * Document 'force' parameter * Create integration test for rebase procedure This test is composed of 3 jobs. The first two jobs run simultaneously, and as such both depend on the previous integration test only. The final job cleans up afterwards, and depends on both of the prior jobs. The two jobs are identical except that they both create a temporary file in a different location. This is to ensure that they conflict. Correctly resolving this conflict by rebasing one deployment over the other, resulting in a deployment containing both files, indicates a successful test.
- Loading branch information
Showing
12 changed files
with
183 additions
and
28 deletions.
There are no files selected for viewing
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
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
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
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
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
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
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
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
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
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,37 +1,58 @@ | ||
| import {exec} from '@actions/exec' | ||
| import buffer from 'buffer' | ||
|
|
||
| let output = '' | ||
| type ExecuteOutput = { | ||
| stdout: string | ||
| stderr: string | ||
| } | ||
|
|
||
| const output: ExecuteOutput = {stdout: '', stderr: ''} | ||
|
|
||
| /** Wrapper around the GitHub toolkit exec command which returns the output. | ||
| * Also allows you to easily toggle the current working directory. | ||
| * | ||
| * @param {string} cmd - The command to execute. | ||
| * @param {string} cwd - The current working directory. | ||
| * @param {boolean} silent - Determines if the in/out should be silenced or not. | ||
| * @param {boolean} ignoreReturnCode - Determines whether to throw an error | ||
| * on a non-zero exit status or to leave implementation up to the caller. | ||
| */ | ||
| export async function execute( | ||
| cmd: string, | ||
| cwd: string, | ||
| silent: boolean | ||
| ): Promise<string> { | ||
| output = '' | ||
| silent: boolean, | ||
| ignoreReturnCode = false | ||
| ): Promise<ExecuteOutput> { | ||
| output.stdout = '' | ||
| output.stderr = '' | ||
|
|
||
| await exec(cmd, [], { | ||
| // Silences the input unless the INPUT_DEBUG flag is set. | ||
| silent, | ||
| cwd, | ||
| listeners: { | ||
| stdout | ||
| } | ||
| listeners: {stdout, stderr}, | ||
| ignoreReturnCode | ||
| }) | ||
|
|
||
| return Promise.resolve(output) | ||
| } | ||
|
|
||
| export function stdout(data: Buffer | string): void { | ||
| const dataString = data.toString().trim() | ||
| if (output.length + dataString.length < buffer.constants.MAX_STRING_LENGTH) { | ||
| output += dataString | ||
| if ( | ||
| output.stdout.length + dataString.length < | ||
| buffer.constants.MAX_STRING_LENGTH | ||
| ) { | ||
| output.stdout += dataString | ||
| } | ||
| } | ||
|
|
||
| export function stderr(data: Buffer | string): void { | ||
| const dataString = data.toString().trim() | ||
| if ( | ||
| output.stderr.length + dataString.length < | ||
| buffer.constants.MAX_STRING_LENGTH | ||
| ) { | ||
| output.stderr += dataString | ||
| } | ||
| } |
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