deploy: 9aa93a7

Author: gbraad

Debugging-guide.html

@@ -493,7 +493,7 @@ <h2 id="checking-the-status-of-the-vm"><a class="header" href="#checking-the-sta
 
                     <nav class="nav-wrapper" aria-label="Page navigation">
                         <!-- Mobile navigation buttons -->
-                            <a rel="prev" href="Developing.html" class="mobile-nav-chapters previous" title="Previous chapter" aria-label="Previous chapter" aria-keyshortcuts="Left">
+                            <a rel="prev" href="Releasing.html" class="mobile-nav-chapters previous" title="Previous chapter" aria-label="Previous chapter" aria-keyshortcuts="Left">
                                 <i class="fa fa-angle-left"></i>
                             </a>
 
@@ -507,7 +507,7 @@ <h2 id="checking-the-status-of-the-vm"><a class="header" href="#checking-the-sta
             </div>
 
             <nav class="nav-wide-wrapper" aria-label="Page navigation">
-                    <a rel="prev" href="Developing.html" class="nav-chapters previous" title="Previous chapter" aria-label="Previous chapter" aria-keyshortcuts="Left">
+                    <a rel="prev" href="Releasing.html" class="nav-chapters previous" title="Previous chapter" aria-label="Previous chapter" aria-keyshortcuts="Left">
                         <i class="fa fa-angle-left"></i>
                     </a>
 

Developing.html

@@ -449,67 +449,6 @@ <h2 id="running-unit-tests"><a class="header" href="#running-unit-tests">Running
 <p>If you need to update mocks use:</p>
 <pre><code class="language-bash">$ make generate_mocks
 </code></pre>
-<h2 id="running-e2e-tests"><a class="header" href="#running-e2e-tests">Running e2e tests</a></h2>
-<p>We have automated e2e tests which keep CRC in shape.</p>
-<h3 id="introduction"><a class="header" href="#introduction">Introduction</a></h3>
-<p>End-to-end (e2e) tests borrow code from <a href="http://github.com/crc-org/clicumber">Clicumber</a> package to provide basic functionality for testing CLI binaries. This facilitates running commands in a persistent shell instance (<code>bash</code>, <code>tcsh</code>, <code>zsh</code>, Command Prompt, or PowerShell), assert its outputs (standard output, standard error, or exit code), check configuration files, and so on. The general functionality of Clicumber is then extended by CRC specific test code to cover the whole functionality of CRC.</p>
-<h3 id="how-to-run"><a class="header" href="#how-to-run">How to run</a></h3>
-<p>First, one needs to set the following flags in <code>Makefile</code>, under <code>e2e</code> target:</p>
-<ul>
-<li><code>--pull-secret-file</code><br />
-absolute path to your OpenShift pull secret.</li>
-<li><code>--bundle-location</code><br />
-if bundle is embedded, this flag should be set to <code>--bundle-location=embedded</code> or not passed at all<br />
-if bundle is not embedded, then absolute path to the bundle should be passed</li>
-<li><code>--crc-binary</code><br />
-if <code>crc</code> binary resides in <code>$GOPATH/bin</code>, then this flag does not need to be passed<br />
-otherwise absolute path to the <code>crc</code> binary should be passed.</li>
-</ul>
-<p>To start e2e tests, run:</p>
-<pre><code class="language-bash">$ make e2e
-</code></pre>
-<h4 id="how-to-run-only-a-subset-of-all-e2e-tests"><a class="header" href="#how-to-run-only-a-subset-of-all-e2e-tests">How to run only a subset of all e2e tests</a></h4>
-<p>Implicitly, all e2e tests for your operating system are executed. If you want to run only tests from one feature file, you have to override <code>GODOG_OPTS</code> environment variable. For example:</p>
-<pre><code class="language-bash">make e2e GODOG_OPTS="--godog.tags='@basic &amp;&amp; @windows'" BUNDLE_LOCATION=&lt;bundle location&gt; PULL_SECRET_FILE=&lt;pull secret path&gt;
-</code></pre>
-<p>Please notice <code>@basic &amp;&amp; @windows</code>, where <code>@basic</code> tag stands for <code>basic.feature</code> file and <code>@windows</code> tag for e2e tests designed for Windows.</p>
-<h3 id="how-to-test-cert-rotation"><a class="header" href="#how-to-test-cert-rotation">How to test cert rotation</a></h3>
-<p>On linux platform first stop the network time sync using:</p>
-<pre><code class="language-bash">$ sudo timedatectl set-ntp off
-</code></pre>
-<p>Set the time 2 month ahead:</p>
-<pre><code class="language-bash">$ sudo date -s '2 month'
-</code></pre>
-<p>Start the crc with <code>CRC_DEBUG_ENABLE_STOP_NTP=true</code> set:</p>
-<pre><code class="language-bash">$ CRC_DEBUG_ENABLE_STOP_NTP=true crc start
-</code></pre>
-<h3 id="logs"><a class="header" href="#logs">Logs</a></h3>
-<p>Test logs can be found in <code>test/e2e/out/test-results</code>.</p>
-<h2 id="releasing-on-github"><a class="header" href="#releasing-on-github">Releasing on GitHub</a></h2>
-<h3 id="releasing-using-the-github-actions-workflow"><a class="header" href="#releasing-using-the-github-actions-workflow">Releasing using the github actions workflow</a></h3>
-<p>The GitHub Actions workflow <a href="https://github.com/crc-org/crc/actions/workflows/release.yml"><code>Publish release on github</code></a> creates a draft release and provides a template with all the component versions and the git change log.</p>
-<p>To start the workflow go to the <a href="https://github.com/crc-org/crc/actions/workflows/release.yml">workflow page</a> and click on the <code>Run Workflow</code> button, make sure to choose the appropriate tag for the release.</p>
-<p>Once the draft release is available, edit it to include the notable changes for the release and press publish to make it public.</p>
-<h3 id="releasing-using-the-gh-releasesh-script"><a class="header" href="#releasing-using-the-gh-releasesh-script">Releasing using the <code>gh-release.sh</code> script</a></h3>
-<p>In the CRC repository, we have a script <a href="https://github.com/crc-org/crc/blob/main/gh-release.sh"><code>gh-release.sh</code></a> which uses the <a href="https://cli.github.com"><code>gh</code></a> tool, make sure it is installed.</p>
-<p>Create a markdown file containing a list of the notable changes named <code>notable_changes.txt</code> in the same directory as the script.</p>
-<p>An example <code>notable_changes.txt</code>:</p>
-<pre><code class="language-bash">$ cat notable_changes.txt
-- Fixes a bug where `oc` binary was not extracted from bundle when using microshift preset [#3581](https://github.com/crc-org/crc/issues/3581)
-- Adds 'microshift' as a possible value to the help string of the 'preset' config option [#3576](https://github.com/crc-org/crc/issues/3576)
-</code></pre>
-<p>Then run the script from the release tag and follow the prompts, it’ll ask for confirmation before pushing the draft release to GitHub.</p>
-<div class="mdbook-callouts mdbook-callouts-note">
-<p class="mdbook-callouts-title">
-  <span class="mdbook-callouts-icon"></span>
-  note
-</p>
-<p>The script will exit with error if it doesn’t find a tag starting with <code>v</code> in the current git HEAD.</p>
-</div>
-<pre><code class="language-bash">$ git checkout v2.18.0
-$ ./gh-release.sh
-</code></pre>
-<p>Verify the draft release on the releases page and if everything looks good press publish to make the release public.</p>
 
                     </main>
 
@@ -519,7 +458,7 @@ <h3 id="releasing-using-the-gh-releasesh-script"><a class="header" href="#releas
                                 <i class="fa fa-angle-left"></i>
                             </a>
 
-                            <a rel="next prefetch" href="Debugging-guide.html" class="mobile-nav-chapters next" title="Next chapter" aria-label="Next chapter" aria-keyshortcuts="Right">
+                            <a rel="next prefetch" href="Testing.html" class="mobile-nav-chapters next" title="Next chapter" aria-label="Next chapter" aria-keyshortcuts="Right">
                                 <i class="fa fa-angle-right"></i>
                             </a>
 
@@ -533,7 +472,7 @@ <h3 id="releasing-using-the-gh-releasesh-script"><a class="header" href="#releas
                         <i class="fa fa-angle-left"></i>
                     </a>
 
-                    <a rel="next prefetch" href="Debugging-guide.html" class="nav-chapters next" title="Next chapter" aria-label="Next chapter" aria-keyshortcuts="Right">
+                    <a rel="next prefetch" href="Testing.html" class="nav-chapters next" title="Next chapter" aria-label="Next chapter" aria-keyshortcuts="Right">
                         <i class="fa fa-angle-right"></i>
                     </a>
             </nav>