build based on 52d14d0

dev/.documenter-siteinfo.json

@@ -1 +1 @@
-{"documenter":{"julia_version":"1.9.3","generation_timestamp":"2023-10-10T18:49:36","documenter_version":"1.1.0"}}
+{"documenter":{"julia_version":"1.9.3","generation_timestamp":"2023-10-13T20:19:20","documenter_version":"1.1.1"}}

dev/contributing/index.html

@@ -30,4 +30,4 @@
    #  s, squash = use commit, but meld into previous commit
    #
    # If you remove a line here THAT COMMIT WILL BE LOST.
-   # However, if you remove everything, the rebase will be aborted.</code></pre><p>Then in the next screen that appears, we can just delete all messages that we do not want to show in the commit. After this is done and we are back to  the console, we have to force push. We need to force push because we rewrote the local commit history.</p><pre><code class="nohighlight hljs">$ git push -uf origin &lt;name_of_local_branch&gt;</code></pre><p>You can find more information about squashing <a href="https://github.com/edx/edx-platform/wiki/How-to-Rebase-a-Pull-Request#squash-your-changes">here</a>.</p><h3 id="Unit-testing"><a class="docs-heading-anchor" href="#Unit-testing">Unit testing</a><a id="Unit-testing-1"></a><a class="docs-heading-anchor-permalink" href="#Unit-testing" title="Permalink"></a></h3><p>Currently a number of checks are run per commit for a given PR.</p><ul><li><code>JuliaFormatter</code> checks if the PR is formatted with <code>.dev/climaformat.jl</code>.</li><li><code>Documentation</code> rebuilds the documentation for the PR and checks if the docs are consistent and generate valid output.</li><li><code>Unit Tests</code> run subsets of the unit tests defined in <code>tests/</code>, using <code>Pkg.test()</code>. The tests are run in parallel to ensure that they finish in a reasonable time. The tests only run the latest commit for a PR, branch and will kill any stale jobs on push. These tests are only run on linux (Ubuntu LTS).</li></ul><p>Unit tests are run against every new commit for a given PR, the status of the unit-tests are not checked during the merge process but act as a sanity check for developers and reviewers. Depending on the content changed in the PR, some CI checks that are not necessary will be skipped.  For example doc only changes do not require the unit tests to be run.</p><h3 id="The-merge-process"><a class="docs-heading-anchor" href="#The-merge-process">The merge process</a><a id="The-merge-process-1"></a><a class="docs-heading-anchor-permalink" href="#The-merge-process" title="Permalink"></a></h3><p>We use <a href="https://bors.tech/"><code>bors</code></a> to manage merging PR&#39;s in the the <code>EnsembleKalmanProcesses</code> repo. If you&#39;re a collaborator and have the necessary permissions, you can type <code>bors try</code> in a comment on a PR to have integration test suite run on that PR, or <code>bors r+</code> to try and merge the code.  Bors ensures that all integration tests for a given PR always pass before merging into <code>main</code>. The integration tests currently run example cases in <code>examples/</code>. Any breaking changes will need to also update the <code>examples/</code>, else bors will fail.</p></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../API/Localizers/">« Localizers</a><a class="docs-footer-nextpage" href="../glossary/">Glossary »</a><div class="flexbox-break"></div><p class="footer-message">Powered by <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> and the <a href="https://julialang.org/">Julia Programming Language</a>.</p></nav></div><div class="modal" id="documenter-settings"><div class="modal-background"></div><div class="modal-card"><header class="modal-card-head"><p class="modal-card-title">Settings</p><button class="delete"></button></header><section class="modal-card-body"><p><label class="label">Theme</label><div class="select"><select id="documenter-themepicker"><option value="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option><option value="auto">Automatic (OS)</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.1.0 on <span class="colophon-date" title="Tuesday 10 October 2023 18:49">Tuesday 10 October 2023</span>. Using Julia version 1.9.3.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
+   # However, if you remove everything, the rebase will be aborted.</code></pre><p>Then in the next screen that appears, we can just delete all messages that we do not want to show in the commit. After this is done and we are back to  the console, we have to force push. We need to force push because we rewrote the local commit history.</p><pre><code class="nohighlight hljs">$ git push -uf origin &lt;name_of_local_branch&gt;</code></pre><p>You can find more information about squashing <a href="https://github.com/edx/edx-platform/wiki/How-to-Rebase-a-Pull-Request#squash-your-changes">here</a>.</p><h3 id="Unit-testing"><a class="docs-heading-anchor" href="#Unit-testing">Unit testing</a><a id="Unit-testing-1"></a><a class="docs-heading-anchor-permalink" href="#Unit-testing" title="Permalink"></a></h3><p>Currently a number of checks are run per commit for a given PR.</p><ul><li><code>JuliaFormatter</code> checks if the PR is formatted with <code>.dev/climaformat.jl</code>.</li><li><code>Documentation</code> rebuilds the documentation for the PR and checks if the docs are consistent and generate valid output.</li><li><code>Unit Tests</code> run subsets of the unit tests defined in <code>tests/</code>, using <code>Pkg.test()</code>. The tests are run in parallel to ensure that they finish in a reasonable time. The tests only run the latest commit for a PR, branch and will kill any stale jobs on push. These tests are only run on linux (Ubuntu LTS).</li></ul><p>Unit tests are run against every new commit for a given PR, the status of the unit-tests are not checked during the merge process but act as a sanity check for developers and reviewers. Depending on the content changed in the PR, some CI checks that are not necessary will be skipped.  For example doc only changes do not require the unit tests to be run.</p><h3 id="The-merge-process"><a class="docs-heading-anchor" href="#The-merge-process">The merge process</a><a id="The-merge-process-1"></a><a class="docs-heading-anchor-permalink" href="#The-merge-process" title="Permalink"></a></h3><p>We use <a href="https://bors.tech/"><code>bors</code></a> to manage merging PR&#39;s in the the <code>EnsembleKalmanProcesses</code> repo. If you&#39;re a collaborator and have the necessary permissions, you can type <code>bors try</code> in a comment on a PR to have integration test suite run on that PR, or <code>bors r+</code> to try and merge the code.  Bors ensures that all integration tests for a given PR always pass before merging into <code>main</code>. The integration tests currently run example cases in <code>examples/</code>. Any breaking changes will need to also update the <code>examples/</code>, else bors will fail.</p></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../API/Localizers/">« Localizers</a><a class="docs-footer-nextpage" href="../glossary/">Glossary »</a><div class="flexbox-break"></div><p class="footer-message">Powered by <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> and the <a href="https://julialang.org/">Julia Programming Language</a>.</p></nav></div><div class="modal" id="documenter-settings"><div class="modal-background"></div><div class="modal-card"><header class="modal-card-head"><p class="modal-card-title">Settings</p><button class="delete"></button></header><section class="modal-card-body"><p><label class="label">Theme</label><div class="select"><select id="documenter-themepicker"><option value="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option><option value="auto">Automatic (OS)</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.1.1 on <span class="colophon-date" title="Friday 13 October 2023 20:19">Friday 13 October 2023</span>. Using Julia version 1.9.3.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>