Skip to content

[No QA] Make deploy workflow manually dispatchable#90249

Merged
francoisl merged 11 commits into
mainfrom
rory-dispatchable-deploy
May 12, 2026
Merged

[No QA] Make deploy workflow manually dispatchable#90249
francoisl merged 11 commits into
mainfrom
rory-dispatchable-deploy

Conversation

@roryabraham
Copy link
Copy Markdown
Contributor

@roryabraham roryabraham commented May 11, 2026

Explanation of Change

Adds a workflow_dispatch trigger to deploy.yml so that deployers can manually re-trigger a staging or production deploy from the GitHub Actions UI without needing to push a new commit to the branch.

The workflow accepts an ENVIRONMENT input (staging or production). When dispatched manually, it checks out the branch corresponding to that environment and runs the deploy from that branch as normal.

Also updates cherry-pick conflict PR descriptions to note that the PR should ideally be merged by a deployer; if merged by a non-deployer, the deploy will fail and must be manually re-triggered (not just retried).

Fixed Issues

$ #89934

Tests

None.

  • Verify that no errors appear in the JS console

Offline tests

n/a

QA Steps

None.

  • Verify that no errors appear in the JS console

PR Author Checklist

  • I linked the correct issue in the ### Fixed Issues section above
  • I wrote clear testing steps that cover the changes made in this PR
    • I added steps for local testing in the Tests section
    • I added steps for the expected offline behavior in the Offline steps section
    • I added steps for Staging and/or Production testing in the QA steps section
    • I added steps to cover failure scenarios (i.e. verify an input displays the correct error message if the entered data is not correct)
    • I turned off my network connection and tested it while offline to ensure it matches the expected behavior (i.e. verify the default avatar icon is displayed if app is offline)
    • I tested this PR with a High Traffic account against the staging or production API to ensure there are no regressions (e.g. long loading states that impact usability).
  • I included screenshots or videos for tests on all platforms
  • I ran the tests on all platforms & verified they passed on:
    • Android: Native
    • Android: mWeb Chrome
    • iOS: Native
    • iOS: mWeb Safari
    • MacOS: Chrome / Safari
    • MacOS: Desktop
  • I verified there are no console errors (if there's a console error not related to the PR, report it or open an issue for it to be fixed)
  • I verified there are no new alerts related to the canBeMissing param for useOnyx
  • I followed proper code patterns (see Reviewing the code)
    • I verified that any callback methods that were added or modified are named for what the method does and never what callback they handle (i.e. toggleReport and not onIconClick)
    • I verified that comments were added to code that is not self explanatory
    • I verified that any new or modified comments were clear, correct English, and explained "why" the code was doing something instead of only explaining "what" the code was doing.
    • I verified any copy / text shown in the product is localized by adding it to src/languages/* files and using the translation method
      • If any non-english text was added/modified, I used JaimeGPT to get English > Spanish translation. I then posted it in #expensify-open-source and it was approved by an internal Expensify engineer. Link to Slack message:
    • I verified all numbers, amounts, dates and phone numbers shown in the product are using the localization methods
    • I verified any copy / text that was added to the app is grammatically correct in English. It adheres to proper capitalization guidelines (note: only the first word of header/labels should be capitalized), and is either coming verbatim from figma or has been approved by marketing (in order to get marketing approval, ask the Bug Zero team member to add the Waiting for copy label to the issue)
    • I verified proper file naming conventions were followed for any new files or renamed files. All non-platform specific files are named after what they export and are not named "index.js". All platform-specific files are named for the platform the code supports as outlined in the README.
    • I verified the JSDocs style guidelines (in STYLE.md) were followed
  • If a new code pattern is added I verified it was agreed to be used by multiple Expensify engineers
  • I followed the guidelines as stated in the Review Guidelines
  • I tested other components that can be impacted by my changes (i.e. if the PR modifies a shared library or component like Avatar, I verified the components using Avatar are working as expected)
  • I verified all code is DRY (the PR doesn't include any logic written more than once, with the exception of tests)
  • I verified any variables that can be defined as constants (ie. in CONST.ts or at the top of the file that uses the constant) are defined as such
  • I verified that if a function's arguments changed that all usages have also been updated correctly
  • If any new file was added I verified that:
    • The file has a description of what it does and/or why is needed at the top of the file if the code is not self explanatory
  • If a new CSS style is added I verified that:
    • A similar style doesn't already exist
    • The style can't be created with an existing StyleUtils function (i.e. StyleUtils.getBackgroundAndBorderStyle(theme.componentBG))
  • If new assets were added or existing ones were modified, I verified that:
    • The assets are optimized and compressed (for SVG files, run npm run compress-svg)
    • The assets load correctly across all supported platforms.
  • If the PR modifies code that runs when editing or sending messages, I tested and verified there is no unexpected behavior for all supported markdown - URLs, single line code, code blocks, quotes, headings, bold, strikethrough, and italic.
  • If the PR modifies a generic component, I tested and verified that those changes do not break usages of that component in the rest of the App (i.e. if a shared library or component like Avatar is modified, I verified that Avatar is working as expected in all cases)
  • If the PR modifies a component related to any of the existing Storybook stories, I tested and verified all stories for that component are still working as expected.
  • If the PR modifies a component or page that can be accessed by a direct deeplink, I verified that the code functions as expected when the deeplink is used - from a logged in and logged out account.
  • If the PR modifies the UI (e.g. new buttons, new UI components, changing the padding/spacing/sizing, moving components, etc) or modifies the form input styles:
    • I verified that all the inputs inside a form are aligned with each other.
    • I added Design label and/or tagged @Expensify/design so the design team can review the changes.
  • If a new page is added, I verified it's using the ScrollView component to make it scrollable when more elements are added to the page.
  • I added unit tests for any new feature or bug fix in this PR to help automatically prevent regressions in this user flow.
  • If the main branch was merged into this PR after a review, I tested again and verified the outcome was still expected according to the Test steps.

Screenshots/Videos

Android: Native
Android: mWeb Chrome
iOS: Native
iOS: mWeb Safari
MacOS: Chrome / Safari
MacOS: Desktop

Add a workflow_dispatch trigger so deployers can manually re-trigger a
staging or production deploy without needing a new push to the branch.
When manually triggered, the workflow checks out the branch corresponding
to the ENVIRONMENT input and derives all environment-specific behavior
from a DEPLOY_ENV env var rather than github.ref. Also guard the
isCherryPick script against the missing commits payload on non-push
triggers, and add a DEPLOY_SHA output so all downstream jobs check out
the correct commit.

Update cherry-pick conflict PR descriptions to note that the PR should
ideally be merged by a deployer; if not, the deploy will fail and must
be manually re-triggered (not retried).

Fixes #89934

Co-authored-by: Cursor <cursoragent@cursor.com>
The env context is not available in job-level if conditions or
reusable workflow with inputs. Expose DEPLOY_ENV as a prep job output
and use needs.prep.outputs.DEPLOY_ENV in those locations instead.

Co-authored-by: Cursor <cursoragent@cursor.com>
@roryabraham

This comment was marked as resolved.

chatgpt-codex-connector[bot]

This comment was marked as resolved.

workflow_dispatch payloads contain no commits array, so the previous
fallback to [] always produced IS_CHERRY_PICK=false. For a manual
redeploy of a cherry-pick to production this caused SHOULD_BUILD_NATIVE
and cherryPickExtraVersionBump to be skipped incorrectly.

When commits are absent, fetch the HEAD commit message via the GitHub
API using the DEPLOY_SHA captured earlier in the same job.

Co-authored-by: Cursor <cursoragent@cursor.com>
@roryabraham

This comment was marked as resolved.

chatgpt-codex-connector[bot]

This comment was marked as resolved.

P2: Fix concurrency group so push and manual dispatch runs for the same
environment share the same group key and cancel each other correctly.
Previously push triggers used refs/heads/staging while dispatches used
staging, so cancel-in-progress didn't apply across trigger types.

P1: Pass DEPLOY_SHA as a REF input to createDeployChecklist.yml so its
checkout always uses the staging branch HEAD rather than whatever ref
dispatched the calling workflow. Add a REF input to that workflow's
workflow_call trigger and use it in the checkout step.

Co-authored-by: Cursor <cursoragent@cursor.com>
@roryabraham

This comment was marked as resolved.

chatgpt-codex-connector[bot]

This comment was marked as resolved.

When a cherry-pick conflict-resolution PR is merged, GitHub creates a
merge commit at HEAD. The cherry-picked commit carrying the
"(cherry-picked to ... by ...)" marker sits under the merge, not at
HEAD itself, so the previous single-commit API lookup always returned
false for this case.

For workflow_dispatch, detect merge commits (parents.length > 1) and
use compareCommits between the first parent and HEAD to retrieve all
merged-in commits, which includes the cherry-pick commit with the marker.

Co-authored-by: Cursor <cursoragent@cursor.com>
@roryabraham

This comment was marked as resolved.

chatgpt-codex-connector[bot]

This comment was marked as resolved.

If a deploy fails after the tag has already been created and pushed,
a manual re-trigger would immediately abort in prep because
`git tag <existing>` exits 128. Make tag creation idempotent: if the
tag already exists at HEAD, skip creation; if it exists at a different
commit, fail loudly to avoid deploying the wrong code.

Co-authored-by: Cursor <cursoragent@cursor.com>
@roryabraham

This comment was marked as resolved.

chatgpt-codex-connector[bot]

This comment was marked as resolved.

For push-triggered runs, fall back to github.sha (the exact commit
that triggered the push) rather than github.ref (the branch name).
Using the branch name risks checking out a newer commit if the branch
advances between the webhook firing and the checkout step, which would
tag and deploy the wrong code on a re-run.

For workflow_dispatch, inputs.ENVIRONMENT is set, so it is used as the
branch ref to check out the target environment's branch tip as intended.

Co-authored-by: Cursor <cursoragent@cursor.com>
@roryabraham

This comment was marked as resolved.

@chatgpt-codex-connector
Copy link
Copy Markdown

Codex Review: Didn't find any major issues. 🎉

ℹ️ About Codex in GitHub

Codex has been enabled to automatically review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

When you sign up for Codex through ChatGPT, Codex can also answer questions or update the PR, like "@codex address that feedback".

@roryabraham roryabraham changed the title Make deploy workflow manually dispatchable [No QA] Make deploy workflow manually dispatchable May 12, 2026
@roryabraham roryabraham requested a review from francoisl May 12, 2026 00:16
@roryabraham roryabraham marked this pull request as ready for review May 12, 2026 00:16
@roryabraham roryabraham requested a review from a team as a code owner May 12, 2026 00:16
@melvin-bot melvin-bot Bot requested review from dmkt9 and removed request for a team May 12, 2026 00:16
@melvin-bot
Copy link
Copy Markdown

melvin-bot Bot commented May 12, 2026

@dmkt9 Please copy/paste the Reviewer Checklist from here into a new comment on this PR and complete it. If you have the K2 extension, you can simply click: [this button]

chatgpt-codex-connector[bot]

This comment was marked as resolved.

For workflow_dispatch, HEAD alone misses the cherry-pick marker in
two cases:
  1. Linear push (Mobile-Expensify path): the marker is amended onto
     the version-bump commit; a final unmarked submodule-update commit
     is pushed on top, becoming HEAD.
  2. Merge commit (conflict-resolution PR): the marker sits on an inner
     commit, not on the merge commit at HEAD.

Replace the per-case merge-commit detection with a single approach that
covers both: list the most recent prior tag on the same branch
(staging or production) and use compareCommits(prevTag, HEAD).
compareCommits follows all parents, so it catches markers in inner
commits of both linear and merge-commit topologies.

Filter by tag suffix to avoid false positives from cherry-picks that
were part of a prior deploy on the same branch.

Co-authored-by: Cursor <cursoragent@cursor.com>
@roryabraham

This comment was marked as resolved.

chatgpt-codex-connector[bot]

This comment was marked as resolved.

actions/checkout uses fetch-depth=1 and fetch-tags=false, so a tag
pushed by a prior run is absent from the local workspace. The previous
logic tried git tag first: it would succeed locally, then git push
would be rejected by the remote because the tag already exists there,
and the idempotent recovery path was never reached.

Fix: fetch the remote tag first. If it now exists locally, check
whether it points to the expected HEAD SHA and skip or fail accordingly.
Only create and push if the tag is truly absent from the remote.

Co-authored-by: Cursor <cursoragent@cursor.com>
@roryabraham
Copy link
Copy Markdown
Contributor Author

@codex review

chatgpt-codex-connector[bot]

This comment was marked as resolved.

A fixed page size of 20 isn't enough for production dispatches: if
more than 20 staging tags have been created since the last production
release, listTags returns only staging tags on the first page and
prevTag is undefined, causing the code to fall back to HEAD only and
miss the cherry-pick marker.

Paginate with per_page=100 until a matching tag (same suffix) is found
or all tags have been exhausted.

Co-authored-by: Cursor <cursoragent@cursor.com>
@roryabraham
Copy link
Copy Markdown
Contributor Author

@codex review

@chatgpt-codex-connector
Copy link
Copy Markdown

Codex Review: Didn't find any major issues. Breezy!

ℹ️ About Codex in GitHub

Codex has been enabled to automatically review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

When you sign up for Codex through ChatGPT, Codex can also answer questions or update the PR, like "@codex address that feedback".

# v6
uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd
with:
ref: ${{ inputs.ENVIRONMENT || github.sha }}
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I cannot run this directly, but the changes look good to me.
Additionally, I have a question regarding the cherryPick.yml file, which mentions re-triggering a failed commit:

      **Important:** This PR should ideally be merged by a member of the [mobile-deployers](https://github.com/orgs/Expensify/teams/mobile-deployers) team. If it is merged by someone who is not a deployer, the staging deploy triggered by the merge will fail and will need to be manually re-triggered (not just retried) via the [deploy workflow](https://github.com/${{ github.repository }}/actions/workflows/deploy.yml).

Since we are using inputs.ENVIRONMENT == staging/production here, a manual re-trigger might initiate the workflow with a more recent commit than the one that originally failed. This seems slightly inconsistent with the instructions in cherryPick.yml. Is this intentional? Please let me know if I am misunderstanding anything.

Comment thread .github/workflows/cherryPick.yml Outdated
Co-authored-by: Francois Laithier <francois@expensify.com>
@roryabraham roryabraham requested a review from francoisl May 12, 2026 21:09
@francoisl
Copy link
Copy Markdown
Contributor

Reviewer Checklist

  • I have verified the author checklist is complete (all boxes are checked off).
  • I verified the correct issue is linked in the ### Fixed Issues section above
  • I verified testing steps are clear and they cover the changes made in this PR
    • I verified the steps for local testing are in the Tests section
    • I verified the steps for Staging and/or Production testing are in the QA steps section
    • I verified the steps cover any possible failure scenarios (i.e. verify an input displays the correct error message if the entered data is not correct)
    • I turned off my network connection and tested it while offline to ensure it matches the expected behavior (i.e. verify the default avatar icon is displayed if app is offline)
  • I checked that screenshots or videos are included for tests on all platforms
  • I included screenshots or videos for tests on all platforms
  • I verified that the composer does not automatically focus or open the keyboard on mobile unless explicitly intended. This includes checking that returning the app from the background does not unexpectedly open the keyboard.
  • I verified tests pass on all platforms & I tested again on:
    • Android: HybridApp
    • Android: mWeb Chrome
    • iOS: HybridApp
    • iOS: mWeb Safari
    • MacOS: Chrome / Safari
  • If there are any errors in the console that are unrelated to this PR, I either fixed them (preferred) or linked to where I reported them in Slack
  • I verified proper code patterns were followed (see Reviewing the code)
    • I verified that any callback methods that were added or modified are named for what the method does and never what callback they handle (i.e. toggleReport and not onIconClick).
    • I verified that comments were added to code that is not self explanatory
    • I verified that any new or modified comments were clear, correct English, and explained "why" the code was doing something instead of only explaining "what" the code was doing.
    • I verified any copy / text shown in the product is localized by adding it to src/languages/* files and using the translation method
    • I verified all numbers, amounts, dates and phone numbers shown in the product are using the localization methods
    • I verified any copy / text that was added to the app is grammatically correct in English. It adheres to proper capitalization guidelines (note: only the first word of header/labels should be capitalized), and is either coming verbatim from figma or has been approved by marketing (in order to get marketing approval, ask the Bug Zero team member to add the Waiting for copy label to the issue)
    • I verified proper file naming conventions were followed for any new files or renamed files. All non-platform specific files are named after what they export and are not named "index.js". All platform-specific files are named for the platform the code supports as outlined in the README.
    • I verified the JSDocs style guidelines (in STYLE.md) were followed
  • If a new code pattern is added I verified it was agreed to be used by multiple Expensify engineers
  • I verified that this PR follows the guidelines as stated in the Review Guidelines
  • I verified other components that can be impacted by these changes have been tested, and I retested again (i.e. if the PR modifies a shared library or component like Avatar, I verified the components using Avatar have been tested & I retested again)
  • I verified all code is DRY (the PR doesn't include any logic written more than once, with the exception of tests)
  • I verified any variables that can be defined as constants (ie. in CONST.ts or at the top of the file that uses the constant) are defined as such
  • If a new component is created I verified that:
    • A similar component doesn't exist in the codebase
    • All props are defined accurately and each prop has a /** comment above it */
    • The file is named correctly
    • The component has a clear name that is non-ambiguous and the purpose of the component can be inferred from the name alone
    • The only data being stored in the state is data necessary for rendering and nothing else
    • For Class Components, any internal methods passed to components event handlers are bound to this properly so there are no scoping issues (i.e. for onClick={this.submit} the method this.submit should be bound to this in the constructor)
    • Any internal methods bound to this are necessary to be bound (i.e. avoid this.submit = this.submit.bind(this); if this.submit is never passed to a component event handler like onClick)
    • All JSX used for rendering exists in the render method
    • The component has the minimum amount of code necessary for its purpose, and it is broken down into smaller components in order to separate concerns and functions
  • If any new file was added I verified that:
    • The file has a description of what it does and/or why is needed at the top of the file if the code is not self explanatory
  • If a new CSS style is added I verified that:
    • A similar style doesn't already exist
    • The style can't be created with an existing StyleUtils function (i.e. StyleUtils.getBackgroundAndBorderStyle(theme.componentBG)
  • If the PR modifies code that runs when editing or sending messages, I tested and verified there is no unexpected behavior for all supported markdown - URLs, single line code, code blocks, quotes, headings, bold, strikethrough, and italic.
  • If the PR modifies a generic component, I tested and verified that those changes do not break usages of that component in the rest of the App (i.e. if a shared library or component like Avatar is modified, I verified that Avatar is working as expected in all cases)
  • If the PR modifies a component related to any of the existing Storybook stories, I tested and verified all stories for that component are still working as expected.
  • If the PR modifies a component or page that can be accessed by a direct deeplink, I verified that the code functions as expected when the deeplink is used - from a logged in and logged out account.
  • If the PR modifies the UI (e.g. new buttons, new UI components, changing the padding/spacing/sizing, moving components, etc) or modifies the form input styles:
    • I verified that all the inputs inside a form are aligned with each other.
    • I added Design label and/or tagged @Expensify/design so the design team can review the changes.
  • If a new page is added, I verified it's using the ScrollView component to make it scrollable when more elements are added to the page.
  • For any bug fix or new feature in this PR, I verified that sufficient unit tests are included to prevent regressions in this flow.
  • If the main branch was merged into this PR after a review, I tested again and verified the outcome was still expected according to the Test steps.
  • I have checked off every checkbox in the PR reviewer checklist, including those that don't apply to this PR.

Screenshots/Videos

N/A

@francoisl francoisl merged commit 26a05aa into main May 12, 2026
18 checks passed
@francoisl francoisl deleted the rory-dispatchable-deploy branch May 12, 2026 21:22
@OSBotify
Copy link
Copy Markdown
Contributor

✋ This PR was not deployed to staging yet because QA is ongoing. It will be automatically deployed to staging after the next production release.

@OSBotify
Copy link
Copy Markdown
Contributor

🚀 Deployed to staging by https://github.com/francoisl in version: 9.3.73-0 🚀

platform result
🕸 web 🕸 success ✅
🤖 android 🤖 failure ❌
🍎 iOS 🍎 success ✅

Bundle Size Analysis (Sentry):

@OSBotify
Copy link
Copy Markdown
Contributor

🚀 Deployed to staging by https://github.com/francoisl in version: 9.3.73-0 🚀

platform result
🕸 web 🕸 success ✅
🤖 android 🤖 success ✅
🍎 iOS 🍎 success ✅

Bundle Size Analysis (Sentry):

@OSBotify
Copy link
Copy Markdown
Contributor

🚀 Deployed to production by https://github.com/Beamanator in version: 9.3.73-4 🚀

platform result
🕸 web 🕸 success ✅
🤖 android 🤖 success ✅
🍎 iOS 🍎 success ✅

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants