build based on 8a5f46e

dev/.documenter-siteinfo.json

@@ -1 +1 @@
-{"documenter":{"julia_version":"1.11.1","generation_timestamp":"2024-10-26T10:47:54","documenter_version":"1.7.0"}}
+{"documenter":{"julia_version":"1.11.1","generation_timestamp":"2024-10-30T10:54:45","documenter_version":"1.7.0"}}

dev/guidelines/index.html

@@ -10,4 +10,4 @@
 using RegistryCI.AutoMerge
 path_to_registry = joinpath(DEPOT_PATH[1], "registries", "General.toml")
 all_pkg_names = AutoMerge.get_all_non_jll_package_names(RegistryInstance(path_to_registry))
-AutoMerge.meets_distance_check(&quot;MyPackage123&quot;, all_pkg_names)</code></pre><pre class="documenter-example-output"><code class="nohighlight hljs ansi">(true, &quot;&quot;)</code></pre><p>where <code>path_to_registry</code> is a path to the registry of interest. For the General Julia registry, usually <code>path_to_registry = joinpath(DEPOT_PATH[1], &quot;registries&quot;, &quot;General.toml&quot;)</code> if you haven&#39;t changed your <code>DEPOT_PATH</code> (or <code>path_to_registry = joinpath(DEPOT_PATH[1], &quot;registries&quot;, &quot;General&quot;)</code> if you have an uncompressed registry at the directory there). This will return a boolean, indicating whether or not your tentative package name passed the check, as well as a string, indicating what the problem is in the event the check did not pass.</p><p>Note that these automerge guidelines are deliberately conservative: it is very possible for a perfectly good name to not pass the automatic checks and require manual merging. They simply exist to provide a fast path so that manual review is not required for every new package.</p><h2 id="List-of-all-GitHub-PR-labels-that-can-influence-AutoMerge"><a class="docs-heading-anchor" href="#List-of-all-GitHub-PR-labels-that-can-influence-AutoMerge">List of all GitHub PR labels that can influence AutoMerge</a><a id="List-of-all-GitHub-PR-labels-that-can-influence-AutoMerge-1"></a><a class="docs-heading-anchor-permalink" href="#List-of-all-GitHub-PR-labels-that-can-influence-AutoMerge" title="Permalink"></a></h2><p>AutoMerge reads certain labels on GitHub registration pull requests to influence its decisions. Specifically, these labels are:</p><ul><li><code>Override AutoMerge: name similarity is okay</code><ul><li>This label can be manually applied by folks with triage-level access to the registry repository.</li><li>AutoMerge skips the &quot;name similarity check&quot; on new package registration PRs with this label.</li></ul></li><li><code>Override AutoMerge: package author approved</code><ul><li>This label can be manually applied, but typically is applied by a separate Github Actions workflow which monitors the PR for comments by the package author, and applies this label if they write <code>[merge approved]</code>.</li><li>This label currently only skips the &quot;sequential version number&quot; check in new versions. In the future, the author-approval mechanism may be used for other checks (on both &quot;new version&quot; registrations and also &quot;new package&quot; registrations).<ul><li>When AutoMerge fails a check that can be skipped by author-approval, it will mention so in the comment, and direct authors to comment <code>[merge approved]</code> if they want to skip the check.</li></ul></li></ul></li></ul></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../">« Home</a><a class="docs-footer-nextpage" href="../regexes/">Regexes »</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="auto">Automatic (OS)</option><option value="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option><option value="catppuccin-latte">catppuccin-latte</option><option value="catppuccin-frappe">catppuccin-frappe</option><option value="catppuccin-macchiato">catppuccin-macchiato</option><option value="catppuccin-mocha">catppuccin-mocha</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.7.0 on <span class="colophon-date" title="Saturday 26 October 2024 10:47">Saturday 26 October 2024</span>. Using Julia version 1.11.1.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
+AutoMerge.meets_distance_check(&quot;MyPackage123&quot;, all_pkg_names)</code></pre><pre class="documenter-example-output"><code class="nohighlight hljs ansi">(true, &quot;&quot;)</code></pre><p>where <code>path_to_registry</code> is a path to the registry of interest. For the General Julia registry, usually <code>path_to_registry = joinpath(DEPOT_PATH[1], &quot;registries&quot;, &quot;General.toml&quot;)</code> if you haven&#39;t changed your <code>DEPOT_PATH</code> (or <code>path_to_registry = joinpath(DEPOT_PATH[1], &quot;registries&quot;, &quot;General&quot;)</code> if you have an uncompressed registry at the directory there). This will return a boolean, indicating whether or not your tentative package name passed the check, as well as a string, indicating what the problem is in the event the check did not pass.</p><p>Note that these automerge guidelines are deliberately conservative: it is very possible for a perfectly good name to not pass the automatic checks and require manual merging. They simply exist to provide a fast path so that manual review is not required for every new package.</p><h2 id="List-of-all-GitHub-PR-labels-that-can-influence-AutoMerge"><a class="docs-heading-anchor" href="#List-of-all-GitHub-PR-labels-that-can-influence-AutoMerge">List of all GitHub PR labels that can influence AutoMerge</a><a id="List-of-all-GitHub-PR-labels-that-can-influence-AutoMerge-1"></a><a class="docs-heading-anchor-permalink" href="#List-of-all-GitHub-PR-labels-that-can-influence-AutoMerge" title="Permalink"></a></h2><p>AutoMerge reads certain labels on GitHub registration pull requests to influence its decisions. Specifically, these labels are:</p><ul><li><code>Override AutoMerge: name similarity is okay</code><ul><li>This label can be manually applied by folks with triage-level access to the registry repository.</li><li>AutoMerge skips the &quot;name similarity check&quot; on new package registration PRs with this label.</li></ul></li><li><code>Override AutoMerge: package author approved</code><ul><li>This label can be manually applied, but typically is applied by a separate Github Actions workflow which monitors the PR for comments by the package author, and applies this label if they write <code>[merge approved]</code>.</li><li>This label currently only skips the &quot;sequential version number&quot; check in new versions. In the future, the author-approval mechanism may be used for other checks (on both &quot;new version&quot; registrations and also &quot;new package&quot; registrations).<ul><li>When AutoMerge fails a check that can be skipped by author-approval, it will mention so in the comment, and direct authors to comment <code>[merge approved]</code> if they want to skip the check.</li></ul></li></ul></li></ul></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../">« Home</a><a class="docs-footer-nextpage" href="../regexes/">Regexes »</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="auto">Automatic (OS)</option><option value="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option><option value="catppuccin-latte">catppuccin-latte</option><option value="catppuccin-frappe">catppuccin-frappe</option><option value="catppuccin-macchiato">catppuccin-macchiato</option><option value="catppuccin-mocha">catppuccin-mocha</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.7.0 on <span class="colophon-date" title="Wednesday 30 October 2024 10:54">Wednesday 30 October 2024</span>. Using Julia version 1.11.1.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>