Skip to content

Commit

Permalink
Deploying to docs from @ 93ca6e8 🚀
Browse files Browse the repository at this point in the history
  • Loading branch information
dkotter committed Aug 30, 2023
1 parent 2d8dbea commit daec690
Show file tree
Hide file tree
Showing 30 changed files with 73 additions and 56 deletions.
2 changes: 1 addition & 1 deletion assets/search.js

Large diffs are not rendered by default.

12 changes: 6 additions & 6 deletions index.html
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ <h1>Cypress Utilities for WordPress</h1>
<a href="#prerequisites" id="prerequisites" style="color: inherit; text-decoration: none;">
<h2>Prerequisites</h2>
</a>
<p>This library requires Cypress. Use <a href="https://github.com/10up/cypress-wp-setup">@10up/cypress-wp-setup</a> to set up Cypress automatically, including this library.</p>
<p>This library requires Cypress. Use <a href="https://github.com/10up/cypress-wp-setup">@10up/cypress-wp-setup</a> to set up Cypress automatically, including this library. If running tests against WordPress 6.3, you&#39;ll probably need to set <code>chromeWebSecurity: false</code> in your Cypress config file. This allows Cypress to properly interact with the iframed Block Editor.</p>

<a href="#installation" id="installation" style="color: inherit; text-decoration: none;">
<h2>Installation</h2>
Expand All @@ -37,7 +37,7 @@ <h3>IntelliSense and code completion for Cypress commands</h3>
<h3>Adding a new command</h3>
</a>
<p>This project uses <code>hygen</code> to scaffold new commands to reduce the effort of manually importing and registering new commands:</p>
<pre><code class="language-sh"><span class="hl-0">$ npx hygen cypress-command new customCommand</span><br/><br/><span class="hl-0">Loaded templates: _templates</span><br/><span class="hl-0"> added: src/commands/custom-command.ts</span><br/><span class="hl-0"> inject: src/index.ts</span><br/><span class="hl-0"> inject: src/index.ts</span><br/><span class="hl-0"> inject: src/index.ts</span>
<pre><code class="language-sh"><span class="hl-0">$ npx hygen cypress-command new customCommand</span><br/><br/><span class="hl-0">Loaded templates: _templates</span><br/><span class="hl-0"> added: src/commands/custom-command.ts</span><br/><span class="hl-0"> inject: src/index.ts</span><br/><span class="hl-0"> inject: src/index.ts</span><br/><span class="hl-0"> inject: src/index.ts</span>
</code></pre>

<a href="#install-the-library-locally" id="install-the-library-locally" style="color: inherit; text-decoration: none;">
Expand All @@ -49,13 +49,13 @@ <h3>Install the library locally</h3>
<a href="#test-against-every-wordpress-major-release" id="test-against-every-wordpress-major-release" style="color: inherit; text-decoration: none;">
<h3>Test against every WordPress major release</h3>
</a>
<p>For every incoming pull request by default on GitHub Actions we automatically perform tests against:</p>
<p>Every incoming pull request will automatically run tests against:</p>
<ul>
<li>current minimum supported WordPress 5.2</li>
<li>our current minimum supported WordPress version, 5.7</li>
<li>WordPress <a href="https://github.com/WordPress/WordPress/tags">latest release</a></li>
<li>current WordPress <a href="https://github.com/WordPress/WordPress/tree/master">future release</a></li>
</ul>
<p>To run tests locally against every WordPress major release since minimum support (5.2) to the latest nightly build (e.g., 6.0-alpha) use this script:</p>
<p>To run tests locally against every WordPress major release since minimum support (5.7) to the latest nightly build (e.g., 6.4-alpha) use this script:</p>
<pre><code class="language-sh"><span class="hl-0">./run-all-cores.sh</span>
</code></pre>
<p>It has optional parameter <code>-s</code> to specify only one test suite to run:</p>
Expand All @@ -76,4 +76,4 @@ <h2>Support Level</h2>
<h2>Like what you see?</h2>
</a>
<p><a href="http://10up.com/contact/"><img src="https://10up.com/uploads/2016/10/10up-Github-Banner.png" alt="Work with us"></a></p>
</div></div><div class="col-4 col-menu menu-sticky-wrap menu-highlight"><nav class="tsd-navigation primary"><ul><li class="current"><a href="modules.html">Modules</a></li><li class=" tsd-kind-module"><a href="modules/commands_activate_all_plugins.html">commands/activate-<wbr/>all-<wbr/>plugins</a></li><li class=" tsd-kind-module"><a href="modules/commands_activate_plugin.html">commands/activate-<wbr/>plugin</a></li><li class=" tsd-kind-module"><a href="modules/commands_check_block_pattern_exists.html">commands/check-<wbr/>block-<wbr/>pattern-<wbr/>exists</a></li><li class=" tsd-kind-module"><a href="modules/commands_check_post_exists.html">commands/check-<wbr/>post-<wbr/>exists</a></li><li class=" tsd-kind-module"><a href="modules/commands_classic_create_post.html">commands/classic-<wbr/>create-<wbr/>post</a></li><li class=" tsd-kind-module"><a href="modules/commands_close_welcome_guide.html">commands/close-<wbr/>welcome-<wbr/>guide</a></li><li class=" tsd-kind-module"><a href="modules/commands_create_post.html">commands/create-<wbr/>post</a></li><li class=" tsd-kind-module"><a href="modules/commands_create_term.html">commands/create-<wbr/>term</a></li><li class=" tsd-kind-module"><a href="modules/commands_deactivate_all_plugins.html">commands/deactivate-<wbr/>all-<wbr/>plugins</a></li><li class=" tsd-kind-module"><a href="modules/commands_deactivate_plugin.html">commands/deactivate-<wbr/>plugin</a></li><li class=" tsd-kind-module"><a href="modules/commands_delete_all_terms.html">commands/delete-<wbr/>all-<wbr/>terms</a></li><li class=" tsd-kind-module"><a href="modules/commands_insert_block.html">commands/insert-<wbr/>block</a></li><li class=" tsd-kind-module"><a href="modules/commands_login.html">commands/login</a></li><li class=" tsd-kind-module"><a href="modules/commands_logout.html">commands/logout</a></li><li class=" tsd-kind-module"><a href="modules/commands_open_document_settings_panel.html">commands/open-<wbr/>document-<wbr/>settings-<wbr/>panel</a></li><li class=" tsd-kind-module"><a href="modules/commands_open_document_settings_sidebar.html">commands/open-<wbr/>document-<wbr/>settings-<wbr/>sidebar</a></li><li class=" tsd-kind-module"><a href="modules/commands_set_permalink_structure.html">commands/set-<wbr/>permalink-<wbr/>structure</a></li><li class=" tsd-kind-module"><a href="modules/commands_upload_media.html">commands/upload-<wbr/>media</a></li><li class=" tsd-kind-module"><a href="modules/commands_wp_cli.html">commands/wp-<wbr/>cli</a></li><li class=" tsd-kind-module"><a href="modules/commands_wp_cli_eval.html">commands/wp-<wbr/>cli-<wbr/>eval</a></li><li class=" tsd-kind-module"><a href="modules/functions_capitalize.html">functions/capitalize</a></li><li class=" tsd-kind-module"><a href="modules/functions_uc_first.html">functions/uc-<wbr/>first</a></li><li class=" tsd-kind-module"><a href="modules/interface_post_data.html">interface/post-<wbr/>data</a></li></ul></nav></div></div></div><footer class="with-border-bottom"><div class="container"><h2>Legend</h2><div class="tsd-legend-group"><ul class="tsd-legend"><li class="tsd-kind-function"><span class="tsd-kind-icon">Function</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li></ul></div><h2>Settings</h2><p>Theme <select id="theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></p></div></footer><div class="container tsd-generator"><p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></div><div class="overlay"></div><script src="assets/main.js"></script></body></html>
</div></div><div class="col-4 col-menu menu-sticky-wrap menu-highlight"><nav class="tsd-navigation primary"><ul><li class="current"><a href="modules.html">Modules</a></li><li class=" tsd-kind-module"><a href="modules/commands_activate_all_plugins.html">commands/activate-<wbr/>all-<wbr/>plugins</a></li><li class=" tsd-kind-module"><a href="modules/commands_activate_plugin.html">commands/activate-<wbr/>plugin</a></li><li class=" tsd-kind-module"><a href="modules/commands_check_block_pattern_exists.html">commands/check-<wbr/>block-<wbr/>pattern-<wbr/>exists</a></li><li class=" tsd-kind-module"><a href="modules/commands_check_post_exists.html">commands/check-<wbr/>post-<wbr/>exists</a></li><li class=" tsd-kind-module"><a href="modules/commands_check_sitemap_exists.html">commands/check-<wbr/>sitemap-<wbr/>exists</a></li><li class=" tsd-kind-module"><a href="modules/commands_classic_create_post.html">commands/classic-<wbr/>create-<wbr/>post</a></li><li class=" tsd-kind-module"><a href="modules/commands_close_welcome_guide.html">commands/close-<wbr/>welcome-<wbr/>guide</a></li><li class=" tsd-kind-module"><a href="modules/commands_create_post.html">commands/create-<wbr/>post</a></li><li class=" tsd-kind-module"><a href="modules/commands_create_term.html">commands/create-<wbr/>term</a></li><li class=" tsd-kind-module"><a href="modules/commands_deactivate_all_plugins.html">commands/deactivate-<wbr/>all-<wbr/>plugins</a></li><li class=" tsd-kind-module"><a href="modules/commands_deactivate_plugin.html">commands/deactivate-<wbr/>plugin</a></li><li class=" tsd-kind-module"><a href="modules/commands_delete_all_terms.html">commands/delete-<wbr/>all-<wbr/>terms</a></li><li class=" tsd-kind-module"><a href="modules/commands_get_block_editor.html">commands/get-<wbr/>block-<wbr/>editor</a></li><li class=" tsd-kind-module"><a href="modules/commands_insert_block.html">commands/insert-<wbr/>block</a></li><li class=" tsd-kind-module"><a href="modules/commands_login.html">commands/login</a></li><li class=" tsd-kind-module"><a href="modules/commands_logout.html">commands/logout</a></li><li class=" tsd-kind-module"><a href="modules/commands_open_document_settings_panel.html">commands/open-<wbr/>document-<wbr/>settings-<wbr/>panel</a></li><li class=" tsd-kind-module"><a href="modules/commands_open_document_settings_sidebar.html">commands/open-<wbr/>document-<wbr/>settings-<wbr/>sidebar</a></li><li class=" tsd-kind-module"><a href="modules/commands_set_permalink_structure.html">commands/set-<wbr/>permalink-<wbr/>structure</a></li><li class=" tsd-kind-module"><a href="modules/commands_upload_media.html">commands/upload-<wbr/>media</a></li><li class=" tsd-kind-module"><a href="modules/commands_wp_cli.html">commands/wp-<wbr/>cli</a></li><li class=" tsd-kind-module"><a href="modules/commands_wp_cli_eval.html">commands/wp-<wbr/>cli-<wbr/>eval</a></li><li class=" tsd-kind-module"><a href="modules/functions_capitalize.html">functions/capitalize</a></li><li class=" tsd-kind-module"><a href="modules/functions_get_iframe.html">functions/get-<wbr/>iframe</a></li><li class=" tsd-kind-module"><a href="modules/functions_uc_first.html">functions/uc-<wbr/>first</a></li><li class=" tsd-kind-module"><a href="modules/interface_post_data.html">interface/post-<wbr/>data</a></li></ul></nav></div></div></div><footer class="with-border-bottom"><div class="container"><h2>Legend</h2><div class="tsd-legend-group"><ul class="tsd-legend"><li class="tsd-kind-function"><span class="tsd-kind-icon">Function</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li></ul></div><h2>Settings</h2><p>Theme <select id="theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></p></div></footer><div class="container tsd-generator"><p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></div><div class="overlay"></div><script src="assets/main.js"></script></body></html>
Loading

0 comments on commit daec690

Please sign in to comment.