[NO QA] Update checklist for cherry-picked PRs #26295

roryabraham · 2023-08-30T14:17:23Z

Details

This PR fixes some broken deploy logic:

We had some regexes in place looking for merged PRs for CPs. However, since we implemented the branch dance we no longer have PRs for CPs by default (only if there's a conflict)
There was nothing in the cherryPick.yml flow that would cause the checklist to be updated. This means that CPs aren't added to the checklist and the version is not updated. That in turn means that the next checklist includes all the PRs which were CP'd with the previous one, which is a pain for Applause and deployers.
A bit of code cleanup to simplify things by moving from promises to async/await, as discussed in this thread

Fixed Issues

$ #21763

Tests / Internal QA

Covered by automated tests
We should also live-test this by CPing it to staging – the checklist should update with the CP.
Monitor deploys and make sure everything is working as expected.

Verify that no errors appear in the JS console

Offline tests

n/a

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 / Chrome
- iOS / native
- iOS / 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 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 the left part of a conditional rendering a React component is a boolean and NOT a string, e.g. myBool && <MyComponent />.
- 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 verified the translation was requested/reviewed 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 approved by marketing by adding the Waiting for Copy label for a copy review on the original GH to get the correct copy.
- 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.js 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 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
- If we are not using the full Onyx data that we loaded, I've added the proper selector in order to ensure the component only re-renders when the data it is using changes
- 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(themeColors.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 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.
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 author checklist, including those that don't apply to this PR.

Screenshots/Videos

Web

Mobile Web - Chrome

Mobile Web - Safari

Desktop

iOS

Android

roryabraham · 2023-08-30T14:17:45Z

Going to forego C+ review here.

roryabraham · 2023-08-30T14:21:14Z

.eslintrc.js

+            rules: {
+                '@lwc/lwc/no-async-await': 'off',
+                'no-await-in-loop': 'off',
+                'no-restricted-syntax': ['error', 'ForInStatement', 'LabeledStatement', 'WithStatement'],


All I'm doing with this statement is allowing this syntax:

for (const pr of PRList) { ... }

Which is very simple. I'm pretty sure the performance concerns from the AirBnb are way out of date but they still haven't updated their ESLint standard because they don't like loops in general. In the case of all our GitHub Actions, I think for-each loops like this are nice simplification because they allow us to do await inside the loop to wait for async stuff in one iteration to finish before moving on to the next.

roryabraham · 2023-08-30T14:22:47Z

.github/actions/javascript/createOrUpdateStagingDeploy/createOrUpdateStagingDeploy.js

Sorry for the big diff ... I'd recommend checking out this branch in your IDE and then comparing it side-by-side with the contents of main in a browser window as needed. I think you'll find the new code much simpler

roryabraham · 2023-08-30T14:29:10Z

Sorry, marking this as WIP to simplify a couple things and break it up into a few smaller PRs

# Conflicts: # .github/actions/javascript/createOrUpdateStagingDeploy/createOrUpdateStagingDeploy.js # .github/actions/javascript/createOrUpdateStagingDeploy/index.js # .github/actions/javascript/getReleaseBody/index.js # .github/actions/javascript/markPullRequestsAsDeployed/index.js # .github/actions/javascript/markPullRequestsAsDeployed/markPullRequestsAsDeployed.js # .github/workflows/cherryPick.yml # tests/unit/CIGitLogicTest.sh # tests/unit/createOrUpdateStagingDeployTest.js

.github/workflows/platformDeploy.yml

roryabraham · 2023-09-11T04:39:11Z

Ready for review!

Edit: ilied

Julesssss · 2023-09-11T05:12:13Z

.github/workflows/platformDeploy.yml

@@ -28,6 +28,25 @@ jobs:
        env:
          GITHUB_TOKEN: ${{ secrets.OS_BOTIFY_TOKEN }}

+  # Note: we're updating the checklist before running the deploys and assuming that it will succeed on at least one platform


I think this makes sense.

Let's say they all fail... the failure message appears on the PR only. But this already happens today and I assume the deployer will already have eyes on that PR -- given that they are waiting on the successful CP

luacmartins · 2023-09-11T05:19:42Z

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 tests pass on all platforms & I tested again on:
- Android / native
- Android / Chrome
- iOS / native
- iOS / Safari
- MacOS / Chrome / Safari
- MacOS / Desktop
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 the left part of a conditional rendering a React component is a boolean and NOT a string, e.g. myBool && <MyComponent />.
- 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 approved by marketing by adding the Waiting for Copy label for a copy review on the original GH to get the correct copy.
- 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.js 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(themeColors.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 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.
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 GH actions only

Web

Mobile Web - Chrome

Mobile Web - Safari

Desktop

iOS

Android

OSBotify · 2023-09-11T05:28:29Z

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

Update checklist for cherry-picked PRs (cherry picked from commit 0cf2496)

OSBotify · 2023-09-11T06:19:26Z

🚀 Cherry-picked to staging by https://github.com/Julesssss in version: 1.3.67-1 🚀

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

OSBotify · 2023-09-11T23:43:31Z

🚀 Deployed to production by https://github.com/AndrewGable in version: 1.3.67-3 🚀

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

Julesssss · 2023-09-12T07:02:45Z

Internal QA successful, the checklist was updated 🎉

roryabraham added 5 commits August 30, 2023 12:20

Create git hook to add CP actor to commit message

fca14f4

Reimplement markPullRequestsAsDeployed

5a447c4

Reimplement and simplify createOrUpdateStagingDeployCash

b52347d

Run createOrUpdateStagingDeploy after platformDeploy completes

35bec35

getPullRequestsBetween now returns an array of numbers

f6a6383

roryabraham added the InternalQA This pull request required internal QA label Aug 30, 2023

roryabraham self-assigned this Aug 30, 2023

roryabraham requested a review from a team as a code owner August 30, 2023 14:17

melvin-bot bot requested review from narefyev91 and removed request for a team August 30, 2023 14:17

roryabraham requested review from luacmartins and a team August 30, 2023 14:17

melvin-bot bot requested review from Ollyws and removed request for a team August 30, 2023 14:17

roryabraham requested review from a team and removed request for narefyev91 and Ollyws August 30, 2023 14:17

melvin-bot bot requested review from burczu and removed request for a team August 30, 2023 14:17

Rebuild GH actions

2bceea3

roryabraham removed the request for review from burczu August 30, 2023 14:18

Expensify deleted a comment from melvin-bot bot Aug 30, 2023

roryabraham commented Aug 30, 2023

View reviewed changes

roryabraham changed the title ~~Update checklist for cherry-picked PRs~~ [WIP] Update checklist for cherry-picked PRs Aug 30, 2023

roryabraham mentioned this pull request Aug 30, 2023

[HOLD for payment 2023-09-20] [HOLD for payment 2023-09-18] Manually CPed App PR did not update the checklist #21763

Closed

roryabraham mentioned this pull request Aug 30, 2023

[No QA] Refactor create or update staging deploy to use async/await #26301

Merged

59 tasks

roryabraham added 2 commits September 11, 2023 12:28

Rebuild GH actions

f36a8cd

roryabraham commented Sep 11, 2023

View reviewed changes

.github/workflows/platformDeploy.yml Outdated Show resolved Hide resolved

roryabraham changed the title ~~[WIP] Update checklist for cherry-picked PRs~~ Update checklist for cherry-picked PRs Sep 11, 2023

roryabraham changed the title ~~Update checklist for cherry-picked PRs~~ [WIP] Update checklist for cherry-picked PRs Sep 11, 2023

Julesssss self-requested a review September 11, 2023 04:41

roryabraham added 2 commits September 11, 2023 12:45

Use version from step instead of needs

5e15589

Optimistically update the checklist at the top of platformDeploy.yml

d12ff8f

roryabraham changed the title ~~[WIP] Update checklist for cherry-picked PRs~~ Update checklist for cherry-picked PRs Sep 11, 2023

Julesssss reviewed Sep 11, 2023

View reviewed changes

Julesssss approved these changes Sep 11, 2023

View reviewed changes

luacmartins approved these changes Sep 11, 2023

View reviewed changes

luacmartins merged commit 0cf2496 into main Sep 11, 2023
13 of 15 checks passed

luacmartins deleted the Rory-FixCPChecklistUpdates branch September 11, 2023 05:20

Julesssss changed the title ~~Update checklist for cherry-picked PRs~~ [NO QA] Update checklist for cherry-picked PRs Sep 11, 2023

OSBotify pushed a commit that referenced this pull request Sep 11, 2023

Merge pull request #26295 from Expensify/Rory-FixCPChecklistUpdates

a671b04

Update checklist for cherry-picked PRs (cherry picked from commit 0cf2496)

OSBotify mentioned this pull request Sep 12, 2023

Deploy Checklist: New Expensify 2023-09-12 #27210

Closed

roryabraham mentioned this pull request Sep 12, 2023

[No QA] Make dummy markdown change for test CP #27215

Merged

59 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[NO QA] Update checklist for cherry-picked PRs #26295

[NO QA] Update checklist for cherry-picked PRs #26295

roryabraham commented Aug 30, 2023

roryabraham commented Aug 30, 2023

roryabraham Aug 30, 2023

roryabraham Aug 30, 2023

roryabraham commented Aug 30, 2023

roryabraham commented Sep 11, 2023 •

edited

Loading

Julesssss Sep 11, 2023

luacmartins commented Sep 11, 2023

OSBotify commented Sep 11, 2023

OSBotify commented Sep 11, 2023

OSBotify commented Sep 11, 2023

Julesssss commented Sep 12, 2023

[NO QA] Update checklist for cherry-picked PRs #26295

[NO QA] Update checklist for cherry-picked PRs #26295

Conversation

roryabraham commented Aug 30, 2023

Details

Fixed Issues

Tests / Internal QA

Offline tests

PR Author Checklist

Screenshots/Videos

roryabraham commented Aug 30, 2023

roryabraham Aug 30, 2023

Choose a reason for hiding this comment

roryabraham Aug 30, 2023

Choose a reason for hiding this comment

roryabraham commented Aug 30, 2023

roryabraham commented Sep 11, 2023 • edited Loading

Julesssss Sep 11, 2023

Choose a reason for hiding this comment

luacmartins commented Sep 11, 2023

Reviewer Checklist

Screenshots/Videos

OSBotify commented Sep 11, 2023

OSBotify commented Sep 11, 2023

OSBotify commented Sep 11, 2023

Julesssss commented Sep 12, 2023

roryabraham commented Sep 11, 2023 •

edited

Loading