Merge branch 'feature/improve-alias-warn' into bugfix/issue-12598

Author: cscheid

CITATION.cff

@@ -20,7 +20,7 @@ authors:
   given-names: "Gordon"
   orcid: "https://orcid.org/0009-0005-1809-8936"
 title: "Quarto"
-version: 1.6
+version: 1.7
 doi: 10.5281/zenodo.5960048
-date-released: 2024-11-27
+date-released: 2025-04-28
 url: "https://github.com/quarto-dev/quarto-cli"

configuration

@@ -61,7 +61,7 @@ export ALGOLIA_SEARCH_INSIGHTS_JS=2.0.3
 
 
 # Quarto Info Version
-export QUARTO_VERSION=1.7
+export QUARTO_VERSION=1.8
 export QUARTO_NAME=Quarto
 
 # Folder names. These are not the same as paths (those variable names end in _PATH).

dev-docs/checklist-make-a-new-quarto-release.md

@@ -2,22 +2,21 @@
 - [ ] create a branch `v1.x`, where x is the version being released
   - `git checkout -b v1.4`
   - `git push origin v1.4`
-- [ ] mark the current release as the stable release in the `main` branch
+- [ ] mark the current release as the new release in the `main` branch
   - [ ] edit QUARTO_VERSION line in `/configuration` to be the new version (e.g. `1.5`)
   - [ ] push the changes to the `main` branch
   - [ ] kick off a v1.5 build in GHA: https://github.com/quarto-dev/quarto-cli/actions/workflows/create-release.yml
     - [ ] ensure the build completes successfully
 - [ ] mark v1.4 release as stable
-  - go to https://github.com/quarto-dev/quarto-cli/releases
-  - find the latest v1.4 release and edit, (eg https://github.com/quarto-dev/quarto-cli/releases/edit/v1.4.549)
-  - at the bottom of the page, there will be two checkboxes, "Set as pre-release" and "Set as latest release":
-    - "Set as pre-release" should be unchecked, and
-    - "Set as latest release" should be checked.
+  - [ ] go to https://github.com/quarto-dev/quarto-cli/releases
+  - [ ] find the latest v1.4 release and edit, (eg https://github.com/quarto-dev/quarto-cli/releases/edit/v1.4.549)
+  - [ ] at the bottom of the page, there will be two checkboxes, "Set as pre-release" and "Set as latest release":
+    - [ ] "Set as pre-release" should be unchecked, and
+    - [ ] "Set as latest release" should be checked.
 - [ ] once the v1.5 build completes, edit the quarto.org website configuration on https://github.com/quarto-dev/quarto-web to reflect the new version
   - this means flipping the profile group configuration in `_quarto.yml` from `[rc,prelease]` to `[prerelease,rc]`
     - [ ] push the changes to the `main` branch
 - [ ] quarto-dev/quarto-web changes
-
   - wait for the downloads file to be automatically updated by the GitHub Action on https://github.com/quarto-dev/quarto-web
     - [ ] wait for https://github.com/quarto-dev/quarto-web/actions/workflows/update-downloads.yml to run (it runs every 15 minutes, or you can manually trigger it)
       - This workflow run rendered the website: https://github.com/quarto-dev/quarto-web/actions/runs/12016407762
@@ -30,20 +29,22 @@
       - [ ] create `docs/prerelease/1.5/{_highlights, index, _pre-release-feature}.qmd` files based on the ones from the previous release
       - [ ] change `docs/prerelease/_highlights.qmd` so its include points to the new version-specific `_highlights.qmd` file (here, 1.5)
       - [ ] change `docs/prerelease/_highlights-release.qmd` so its include points to the new version-specific `_highlights.qmd` file (here, 1.4)
-    - [ ] add the stable version to the older downloads list, like [this example](https://github.com/quarto-dev/quarto-web/commit/85ef62ec5036026d62d57f9cfb190d8b923b2d43)
-      - [ ] run `quarto run tools/release-notes.R` to generate the release notes
+    - [ ] add the stable version to the older downloads list by editing /docs/download/_download-older.yml
+    - [ ] run `quarto run tools/release-notes.R` to generate the release notes
   - [ ] push the changes to `prerelease` branch, ensure they build correctly
-  - [ ] Merge the `prerelease` branch into `main`
+  - [ ] Merge the `prerelease` branch into `main`, push to `main`
     - [ ] ensure the build completes successfully
-  - [ ] Merge `main` into `prerelease`
+  - [ ] Merge `main` into `prerelease`, push to `prerelease`
     - [ ] ensure the build completes successfully
-  - [ ] Create new tag on `main` (here, `v1.5`)
-    - [ ] `git tag -a v1.5 -m "v1.5"`
-    - [ ] `git push origin v1.5`
+  - [ ] Create new tag on `main` with stable release version number (here, `v1.4`) to mark when the new main site version went live
+    - [ ] `git tag -a v1.4 -m "v1.4"`
+    - [ ] `git push origin v1.4`
   - [ ] Update `prerelease` version number (here, `v1.5`)
     - [ ] edit `_quarto-prerelease-docs.yml` to point to the new version
   - [ ] publish the release blog post that should exist in https://github.com/quarto-dev/quarto-web/tree/main/docs/blog/posts
-        by removing the `draft: true` line in the metadata and changing the date to match the release date. Do this on a branch off of `main` to trigger our PR automation to make the corresponding change to `prerelease`.
+    - [ ] Create a branch off of `main` (to trigger our PR automation to make the corresponding change to `prerelease`).
+    - [ ] Removing the `draft: true` line in the metadata 
+    - [ ] Change the date to match the release date. 
 
 - [ ] Update https://github.com/quarto-dev/quarto-cli/blob/main/CITATION.cff
 - [ ] Packaging and package managers, etc
@@ -55,8 +56,8 @@
       - Check the "Whether to publish or not the package on chocolatey" checkbox
     - Wait for @cderv to receive email confirmation, no action needed
   - [ ] pypi
-    - Goto the [quarto-cli-pypi repo](https://github.com/quarto-dev/quarto-cli-pypi)
-    - Update `version.txt` to be the version you'd like to publish and commit
+    - Go to the [quarto-cli-pypi repo](https://github.com/quarto-dev/quarto-cli-pypi)
+    - [ ] Update `version.txt` to be the version you'd like to publish and commit
     - Go to actions
       - Select 'Publish Quarto PyPi'
       - [ ] Click "Run Workflow"

news/changelog-1.8.md

@@ -0,0 +1,7 @@
+All changes included in 1.8:
+
+## Projects
+
+### `website`
+
+- ([#12551](https://github.com/quarto-dev/quarto-cli/pull/12551)): Improve warning issued when `aliases` would overwrite an existing document.

src/project/types/website/website-aliases.ts

@@ -106,10 +106,17 @@ export async function updateAliases(
 
     // Write the redirect file
     if (allOutputFiles.find((outputFile) => outputFile === targetFile)) {
-      // Do not, this is the same name as an output file!
-      warning(
-        `Aliases that you have created would overwrite the output file ${targetFile}. The aliases file was not created.`,
-      );
+      for (
+        const offendingAlias of targetHrefs.filter(
+          (targetHref) =>
+            targetHref.href ===
+              relative(dirname(targetHref.outputFile), targetFile),
+        )
+      ) {
+        warning(
+          `Requested alias ${targetFile} -> ${offendingAlias.outputFile} would overwrite the target. Skipping.`,
+        );
+      }
     } else {
       // Write, this is a safe file
       writeMultipleRedirectPage(targetFile, redirects);

src/resources/formats/html/giscus/giscus.ejs

@@ -13,5 +13,25 @@
         <%- giscus.loading ? `data-loading=${giscus.loading}` : '' %>
         async>
 </script>
+<script type="application/javascript">
+  const giscusIframeObserver = new MutationObserver(function (mutations) {
+    mutations.forEach(function (mutation) {
+      mutation.addedNodes.forEach(function (addedNode) {
+        if (addedNode.matches && addedNode.matches('div.giscus')) {
+          const giscusIframe = addedNode.querySelector('iframe.giscus-frame');
+          if(giscusIframe) {
+            giscusIframe.addEventListener("load", function() {
+              window.setTimeout(() => {
+                toggleGiscusIfUsed(hasAlternateSentinel(), authorPrefersDark);
+              }, 100);
+            });
+            giscusIframeObserver.disconnect();
+          }
+        }
+      });
+    });
+  });
+  giscusIframeObserver.observe(document.body, { childList: true, subtree: true });
+</script>
 <input type="hidden" id="giscus-base-theme" value="<%- giscus.baseTheme %>">
 <input type="hidden" id="giscus-alt-theme" value="<%- giscus.altTheme %>">

src/resources/formats/html/templates/quarto-html-after-body.ejs

@@ -22,7 +22,7 @@
   
       window.document.body.appendChild(a);
     }
-    window.setColorSchemeToggle(window.hasAlternateSentinel())
+    setColorSchemeToggle(hasAlternateSentinel())
 
     <% } %>
   

src/resources/formats/html/templates/quarto-html-before-body.ejs

@@ -21,7 +21,7 @@
       }
     }
 
-    window.setColorSchemeToggle = (alternate) => {
+    const setColorSchemeToggle = (alternate) => {
       const toggles = window.document.querySelectorAll('.quarto-color-scheme-toggle');
       for (let i=0; i < toggles.length; i++) {
         const toggle = toggles[i];
@@ -56,7 +56,7 @@
       manageTransitions('#quarto-margin-sidebar .nav-link', true);
 
       // Switch the toggles
-      window.setColorSchemeToggle(alternate)
+      setColorSchemeToggle(alternate)
 
       // Hack to workaround the fact that safari doesn't
       // properly recolor the scrollbar when toggling (#1455)
@@ -103,7 +103,7 @@
       return window.location.protocol === 'file:';
     }
 
-    window.hasAlternateSentinel = () => {
+    const hasAlternateSentinel = () => {
       let styleSentinel = getColorSchemeSentinel();
       if (styleSentinel !== null) {
         return styleSentinel === "alternate";
@@ -136,7 +136,7 @@
   
       let newTheme = '';
   
-      if(darkModeDefault) {
+      if(authorPrefersDark) {
         newTheme = isAlternate ? baseTheme : alternateTheme;
       } else {
         newTheme = isAlternate ? alternateTheme : baseTheme;
@@ -164,11 +164,12 @@
       }
     };
 
+    const authorPrefersDark = <%= darkModeDefault %>;
     <% if (respectUserColorScheme) { %>
     const queryPrefersDark = window.matchMedia('(prefers-color-scheme: dark)');
     const darkModeDefault = queryPrefersDark.matches;
     <% } else { %>
-    const darkModeDefault = <%= darkModeDefault %>;
+    const darkModeDefault = authorPrefersDark;
     <% } %>
 
     <% if (!darkModeDefault) { %>
@@ -181,7 +182,7 @@
     // Dark / light mode switch
     window.quartoToggleColorScheme = () => {
       // Read the current dark / light value
-      let toAlternate = !window.hasAlternateSentinel();
+      let toAlternate = !hasAlternateSentinel();
       toggleColorMode(toAlternate);
       setStyleSentinel(toAlternate);
       toggleGiscusIfUsed(toAlternate, darkModeDefault);
@@ -199,7 +200,7 @@
     <% } %>
 
     // Switch to dark mode if need be
-    if (window.hasAlternateSentinel()) {
+    if (hasAlternateSentinel()) {
       toggleColorMode(true);
     } else {
       toggleColorMode(false);