[No QA] Skip tests, lint and deploys for unrelated changes #30315

roryabraham · 2023-10-24T23:43:03Z

Details

This is a time optimization to skip workflows in certain scenarios:

performance tests (which typically take about 9-10 minutes) are skipped for PRs that don't touch the main app
lint is skipped for PRs that don't touch js, ts, tsx, or sh files, because those are all the files we lint
preDeploy is skipped for PRS that don't touch the main app
test.yml is skipped for PRs that don't touch JavaScript, TypeScript, and don't change package versions
Typecheck is skipped for PRs that don't touch TypeScript and don't change package versions
Welcome message is extracted to its own workflow and refactored to stop using 3rd party actions

Fixed Issues

$ n/a

Tests

Merge this PR
Put up a PR that only changes files in .github
Verify that the reassure tests are automatically skipped
Look at any PR that affects files not listed in paths-ignore
Verify that the reassure tests are not skipped.

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 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

Android: Native

Android: mWeb Chrome

iOS: Native

iOS: mWeb Safari

MacOS: Chrome / Safari

MacOS: Desktop

melvin-bot · 2023-10-24T23:48:17Z

@Li357 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]

roryabraham · 2023-10-24T23:48:56Z

Part of the reason I did this PR was as an exploratory measure for #9725 – if we can skip unnecessary workflows that would run on large runners that will save us money in the form of GitHub Actions minutes

AndrewGable · 2023-10-25T16:15:43Z

I think you can run these tests against this PR before merging, can we do that?

# Conflicts: # .github/workflows/preDeploy.yml

roryabraham · 2023-10-25T19:04:07Z

I think you can run these tests against this PR before merging

How?

AndrewGable · 2023-10-25T19:19:56Z

Push changes to *.js files, verify lint passes, undo the change verify it doesn't run (as it's doing now)

roryabraham · 2023-10-26T21:38:00Z

Tests and lint running after pushing change in JS file, but no typecheck ✅

roryabraham · 2023-10-26T21:43:40Z

TS change triggering typescript checks ✅

roryabraham · 2023-10-26T21:44:39Z

Back to just GitHub Actions changes ✅

roryabraham · 2023-10-26T21:46:22Z

Markdown change in contributingGuides triggers no additional CI stuff ✅

roryabraham · 2023-10-26T21:47:35Z

Markdown change in docs folder does trigger HelpDot stuff ✅

OSBotify · 2023-10-26T21:48:41Z

A preview of your ExpensifyHelp changes have been deployed to https://15f7a4d6.helpdot.pages.dev ⚡️

roryabraham · 2023-10-26T22:15:00Z

This is now well-tested and working well

roryabraham · 2023-10-26T22:19:36Z

The only thing that hasn't been live-tested is the new welcome message. However, I did do a fair amount of local testing on the gh cli stuff, which is prettymuch the only new thing. To see that in action locally:

Find the merge commit sha of a recently merged PR, such as e51b21b19d3aa345f3fcf8f3080ae19138cd5ed8
Then run the following in your terminal:

read -r number author < <(gh pr list --search e51b21b19d3aa345f3fcf8f3080ae19138cd5ed8 --state merged --json 'number,author' | jq -r '.[0] | [.number, .author.login] | join(" ")')
echo "$number"
echo "$author"

works ✅ #30099

AndrewGable

Love it, thank you for all the testing!

AndrewGable · 2023-10-26T22:24:14Z