Skip to content

[NO-QA]Add Workflow run URL to triggerWorkflowAndWait #7250

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.

Sign up for GitHub

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

Merged
roryabraham merged 1 commit into from
Jan 17, 2022
Merged

[NO-QA]Add Workflow run URL to triggerWorkflowAndWait #7250

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 13 additions & 5 deletions .github/actions/triggerWorkflowAndWait/index.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,12 @@ const WORKFLOW_COMPLETION_TIMEOUT = 7200000;
*/
const POLL_RATE = 10000;

/**
* URL prefixed to a specific workflow run
* @type {string}
*/
const WORKFLOW_RUN_URL_PREFIX = 'https://github.com/Expensify/App/actions/runs/';

const run = function () {
const workflow = core.getInput('WORKFLOW', {required: true});
const inputs = ActionUtils.getJSONInput('INPUTS', {required: false}, {});
Expand All @@ -55,6 +61,7 @@ const run = function () {
// 4) Then we can poll and wait for that new workflow run to conclude
let previousWorkflowRunID;
let newWorkflowRunID;
let newWorkflowRunURL;
let hasNewWorkflowStarted = false;
let workflowCompleted = false;
return GithubUtils.getLatestWorkflowRunID(workflow)
Expand Down Expand Up @@ -89,6 +96,7 @@ const run = function () {
return GithubUtils.getLatestWorkflowRunID(workflow)
.then((lastWorkflowRunID) => {
newWorkflowRunID = lastWorkflowRunID;
newWorkflowRunURL = WORKFLOW_RUN_URL_PREFIX + newWorkflowRunID;
hasNewWorkflowStarted = newWorkflowRunID !== previousWorkflowRunID;

if (!hasNewWorkflowStarted) {
Expand All @@ -104,7 +112,7 @@ const run = function () {
process.exit(1);
}
} else {
console.log(`\n🚀 New ${workflow} run with ID ${newWorkflowRunID} has started`);
console.log(`\n🚀 New ${workflow} run ${newWorkflowRunURL} has started`);
}
})
.catch((err) => {
Expand All @@ -123,7 +131,7 @@ const run = function () {
() => !workflowCompleted && waitTimer < WORKFLOW_COMPLETION_TIMEOUT,
_.throttle(
() => {
console.log(`\n⏳ Waiting for workflow run ${newWorkflowRunID} to finish...`);
console.log(`\n⏳ Waiting for workflow run ${newWorkflowRunURL} to finish...`);
return GithubUtils.octokit.actions.getWorkflowRun({
owner: GithubUtils.GITHUB_OWNER,
repo: GithubUtils.EXPENSIFY_CASH_REPO,
Expand All @@ -134,18 +142,18 @@ const run = function () {
waitTimer += POLL_RATE;
if (waitTimer > WORKFLOW_COMPLETION_TIMEOUT) {
// eslint-disable-next-line max-len
const err = new Error(`After ${WORKFLOW_COMPLETION_TIMEOUT / 1000 / 60 / 60} hours, workflow ${newWorkflowRunID} did not complete.`);
const err = new Error(`After ${WORKFLOW_COMPLETION_TIMEOUT / 1000 / 60 / 60} hours, workflow ${newWorkflowRunURL} did not complete.`);
console.error(err);
core.setFailed(err);
process.exit(1);
}
if (workflowCompleted) {
if (data.conclusion === 'success') {
// eslint-disable-next-line max-len
console.log(`\n🎉 ${workflow} run ${newWorkflowRunID} completed successfully! 🎉`);
console.log(`\n🎉 ${workflow} run ${newWorkflowRunURL} completed successfully! 🎉`);
} else {
// eslint-disable-next-line max-len
const err = new Error(`🙅‍ ${workflow} run ${newWorkflowRunID} finished with conclusion ${data.conclusion}`);
const err = new Error(`🙅‍ ${workflow} run ${newWorkflowRunURL} finished with conclusion ${data.conclusion}`);
console.error(err.message);
core.setFailed(err);
process.exit(1);
Expand Down
18 changes: 13 additions & 5 deletions .github/actions/triggerWorkflowAndWait/triggerWorkflowAndWait.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,12 @@ const WORKFLOW_COMPLETION_TIMEOUT = 7200000;
*/
const POLL_RATE = 10000;

/**
* URL prefixed to a specific workflow run
* @type {string}
*/
const WORKFLOW_RUN_URL_PREFIX = 'https://github.com/Expensify/App/actions/runs/';

const run = function () {
const workflow = core.getInput('WORKFLOW', {required: true});
const inputs = ActionUtils.getJSONInput('INPUTS', {required: false}, {});
Expand All @@ -45,6 +51,7 @@ const run = function () {
// 4) Then we can poll and wait for that new workflow run to conclude
let previousWorkflowRunID;
let newWorkflowRunID;
let newWorkflowRunURL;
let hasNewWorkflowStarted = false;
let workflowCompleted = false;
return GithubUtils.getLatestWorkflowRunID(workflow)
Expand Down Expand Up @@ -79,6 +86,7 @@ const run = function () {
return GithubUtils.getLatestWorkflowRunID(workflow)
.then((lastWorkflowRunID) => {
newWorkflowRunID = lastWorkflowRunID;
newWorkflowRunURL = WORKFLOW_RUN_URL_PREFIX + newWorkflowRunID;
hasNewWorkflowStarted = newWorkflowRunID !== previousWorkflowRunID;

if (!hasNewWorkflowStarted) {
Expand All @@ -94,7 +102,7 @@ const run = function () {
process.exit(1);
}
} else {
console.log(`\n🚀 New ${workflow} run with ID ${newWorkflowRunID} has started`);
console.log(`\n🚀 New ${workflow} run ${newWorkflowRunURL} has started`);
}
})
.catch((err) => {
Expand All @@ -113,7 +121,7 @@ const run = function () {
() => !workflowCompleted && waitTimer < WORKFLOW_COMPLETION_TIMEOUT,
_.throttle(
() => {
console.log(`\n⏳ Waiting for workflow run ${newWorkflowRunID} to finish...`);
console.log(`\n⏳ Waiting for workflow run ${newWorkflowRunURL} to finish...`);
return GithubUtils.octokit.actions.getWorkflowRun({
owner: GithubUtils.GITHUB_OWNER,
repo: GithubUtils.EXPENSIFY_CASH_REPO,
Expand All @@ -124,18 +132,18 @@ const run = function () {
waitTimer += POLL_RATE;
if (waitTimer > WORKFLOW_COMPLETION_TIMEOUT) {
// eslint-disable-next-line max-len
const err = new Error(`After ${WORKFLOW_COMPLETION_TIMEOUT / 1000 / 60 / 60} hours, workflow ${newWorkflowRunID} did not complete.`);
const err = new Error(`After ${WORKFLOW_COMPLETION_TIMEOUT / 1000 / 60 / 60} hours, workflow ${newWorkflowRunURL} did not complete.`);
console.error(err);
core.setFailed(err);
process.exit(1);
}
if (workflowCompleted) {
if (data.conclusion === 'success') {
// eslint-disable-next-line max-len
console.log(`\n🎉 ${workflow} run ${newWorkflowRunID} completed successfully! 🎉`);
console.log(`\n🎉 ${workflow} run ${newWorkflowRunURL} completed successfully! 🎉`);
} else {
// eslint-disable-next-line max-len
const err = new Error(`🙅‍ ${workflow} run ${newWorkflowRunID} finished with conclusion ${data.conclusion}`);
const err = new Error(`🙅‍ ${workflow} run ${newWorkflowRunURL} finished with conclusion ${data.conclusion}`);
console.error(err.message);
core.setFailed(err);
process.exit(1);
Expand Down