Skip to content
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.

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

CYCLOUD-1740 multi repo best practices #5562

Merged
merged 10 commits into from
Nov 16, 2023

Conversation

jaffrepaul
Copy link
Contributor

Add Cloud project best practices around having tests in a different repo than the source code.

Copy link

netlify bot commented Nov 14, 2023

Deploy Preview for benevolent-cat-040f48 ready!

Name Link
🔨 Latest commit e2a01d4
🔍 Latest deploy log https://app.netlify.com/sites/benevolent-cat-040f48/deploys/655660c720ea920008824453
😎 Deploy Preview https://deploy-preview-5562--benevolent-cat-040f48.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

@jaffrepaul jaffrepaul marked this pull request as draft November 14, 2023 22:56

### Multi-repo Implementation

There is a sceario where you may have Cypress tests in a repo separate from the application code itself. This creates a sub-optimal [Branch Review](guides/cloud/branch-review) experience considering the commit and branch interpretation of each git directory.
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
There is a sceario where you may have Cypress tests in a repo separate from the application code itself. This creates a sub-optimal [Branch Review](guides/cloud/branch-review) experience considering the commit and branch interpretation of each git directory.
There is a scenario where you may have Cypress tests in a repo separate from the application code itself. This creates a sub-optimal [Branch Review](guides/cloud/branch-review) experience considering the commit and branch interpretation of each git directory.

...though I wonder if we need to explicitly call out branch review here; it'd be problematic for really any sort of VCS integration we have, including statuses/PR comments, etc.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Makes sense. I figured it may be useful to callout a practical area in the product this would impact but we can make it more general to VC.

@pstakoun any other thoughts so I can batch changes?

Copy link
Contributor

Choose a reason for hiding this comment

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

I agree with making it more general and also mention Branch Review as an example of a feature that is impacted.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@pstakoun I took out the direct mention of branch review in the last commit. Are you saying we should still leverage it in some way?

Copy link
Contributor

Choose a reason for hiding this comment

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

nah this is fine. I'd just maybe link to this section from within the branch review docs


- Link the GitHub integration to the Cypress config/tests repo
- Ensure any runs recorded to **Test Project** are related to test code changes in the Cypress config/tests repo
- the application code repo state that the tests are executed against here could likewise be captured as tags here, if necessary.
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
- the application code repo state that the tests are executed against here could likewise be captured as tags here, if necessary.
- The application code repo state that the tests are executed against here could likewise be captured as tags here, if necessary.


### Multi-repo Implementation

There is a sceario where you may have Cypress tests in a repo separate from the application code itself. This creates a sub-optimal [Branch Review](guides/cloud/branch-review) experience considering the commit and branch interpretation of each git directory.
Copy link
Contributor

Choose a reason for hiding this comment

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

I agree with making it more general and also mention Branch Review as an example of a feature that is impacted.

@jaffrepaul jaffrepaul force-pushed the CYCLOUD-1740-multi-repo-best-practices branch from 8868f42 to 9a2ccc9 Compare November 15, 2023 19:57
@jaffrepaul jaffrepaul marked this pull request as ready for review November 15, 2023 19:58
@jaffrepaul jaffrepaul force-pushed the CYCLOUD-1740-multi-repo-best-practices branch from 98f467c to 1c498af Compare November 15, 2023 21:39
@jaffrepaul jaffrepaul merged commit 06e568f into main Nov 16, 2023
6 checks passed
@jaffrepaul jaffrepaul deleted the CYCLOUD-1740-multi-repo-best-practices branch November 16, 2023 18:46
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.

3 participants