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

Update DEPLOY.md #5554

Merged
merged 4 commits into from
Oct 31, 2019
Merged

Update DEPLOY.md #5554

merged 4 commits into from
Oct 31, 2019

Conversation

flotwig
Copy link
Contributor

@flotwig flotwig commented Oct 31, 2019

  • Document kitchensink release process better
  • Clarify pushing up the release commit

- Document kitchensink release process better
- Clarify pushing up the release commit
@cypress-bot
Copy link
Contributor

cypress-bot bot commented Oct 31, 2019

Thanks for the contribution! Below are some guidelines Cypress uses when doing PR reviews.

  • Please write [WIP] in the title of your Pull Request if your PR is not ready for review - someone will review your PR as soon as the [WIP] is removed.
  • Please familiarize yourself with the PR Review Checklist and feel free to make updates on your PR based on these guidelines.

PR Review Checklist

If any of the following requirements can't be met, leave a comment in the review selecting 'Request changes', otherwise 'Approve'.

User Experience

  • The feature/bugfix is self-documenting from within the product.
  • The change provides the end user with a way to fix their problem (no dead ends).

Functionality

  • The code works and performs its intended function with the correct logic.
  • Performance has been factored in (for example, the code cleans up after itself to not cause memory leaks).
  • The code guards against edge cases and invalid input and has tests to cover it.

Maintainability

  • The code is readable (too many nested 'if's are a bad sign).
  • Names used for variables, methods, etc, clearly describe their function.
  • The code is easy to understood and there are relevant comments explaining.
  • New algorithms are documented in the code with link(s) to external docs (flowcharts, w3c, chrome, firefox).
  • There are comments containing link(s) to the addressed issue (in tests and code).

Quality

  • The change does not reimplement code.
  • There's not a module from the ecosystem that should be used instead.
  • There is no redundant or duplicate code.
  • There are no irrelevant comments left in the code.
  • Tests are testing the code’s intended functionality in the best way possible.

Internal

  • The original issue has been tagged with a release in ZenHub.

DEPLOY.md Outdated Show resolved Hide resolved
DEPLOY.md Outdated
13. Bump `version` in `package.json` from `develop` branch and then merge into `master`.
14. Using [cypress-io/release-automations][release-automations]:
9. If needed, push out the updated changes to the docs manifest to `on.cypress.io`.
10. If needed, push out an updated [`cypress-example-kitchensink`][cypress-example-kitchensink] on `example.cypress.io`
Copy link
Member

Choose a reason for hiding this comment

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

I'm not sure how fully you want to document this here, but how would you push this out? Is there some script or something that should be run?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I honestly don't know, I think Brian has a script or something, @brian-mann?

DEPLOY.md Outdated Show resolved Hide resolved
Copy link
Member

@jennifer-shehane jennifer-shehane left a comment

Choose a reason for hiding this comment

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

I'd like to see more links in the Deploy doc in general. It's still making some assumptions that you know where all the other parts are.

@cypress
Copy link

cypress bot commented Oct 31, 2019



Test summary

3474 0 46 0


Run details

Project cypress
Status Passed
Commit 33a25af
Started Oct 31, 2019 9:02 PM
Ended Oct 31, 2019 9:06 PM
Duration 04:04 💡
OS Linux Debian - 9.8
Browser Multiple

View run in Cypress Dashboard ➡️


This comment has been generated by cypress-bot as a result of this project's GitHub integration settings. You can manage this integration in this project's settings in the Cypress Dashboard

DEPLOY.md Outdated Show resolved Hide resolved
flotwig and others added 3 commits October 31, 2019 16:56
Co-Authored-By: Jennifer Shehane <[email protected]>
Co-Authored-By: Jennifer Shehane <[email protected]>
Co-Authored-By: Jennifer Shehane <[email protected]>
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.

2 participants