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

docs: extend included examples #1246

Merged

Conversation

MikeMcC399
Copy link
Collaborator

Change

The included/README is extended regarding usage of the Cypress Docker image cypress/included

  1. The examples are aligned with the base/README and browsers/README documents.

  2. A section "Continuous Integration" is added, with sub-sections

    • GitHub Actions
    • GitLab Pipelines
  3. A missing cypress- string is added to the tag schema

  4. Version-specific examples are updated to latest Cypress 13.15.1

@cypress-app-bot
Copy link

@MikeMcC399
Copy link
Collaborator Author

@MikeMcC399 MikeMcC399 marked this pull request as ready for review November 4, 2024 11:54
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.

These are great changes! Thanks!

@jennifer-shehane jennifer-shehane merged commit 9c86f23 into cypress-io:master Nov 4, 2024
33 checks passed
@MikeMcC399
Copy link
Collaborator Author

@jennifer-shehane

These are great changes! Thanks!

  • I'm happy this has been merged! The changes have been queued up for a while on my side and they now make the documentation more consistent, coherent and comprehensive.

  • I would have like to have made some smaller incremental updates, however the previous structure of the README, which was written more like a blog post, made that difficult. So this PR is a bit bigger than others that I have submitted in the past.

  • I tried to cover the essential basics and I've dropped some of the less mainstream uses. I manually tested each of the examples. That is when I noticed the missing Linux release version in the debug logs, which led to me posting issue Module API results.osVersion contains only Linux distribution without release version cypress#30533.

@MikeMcC399 MikeMcC399 deleted the extend/examples-included branch November 4, 2024 15:49
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
3 participants