Merge branch 'main' into jk/engine-commands

Author: jkrumbiegel

.github/ISSUE_TEMPLATE/bug_report.yml

@@ -6,22 +6,22 @@ body:
   - type: markdown
     attributes:
       value: |
-        Welcome to the quarto GitHub repository!
+        Welcome to the Quarto CLI GitHub repository!
         We are always happy to hear feedback from our users.
 
         This is the repository for the command-line program `quarto`:
 
         - If you're reporting an issue with the VS Code extension, please visit https://github.com/quarto-dev/quarto
         - If you're reporting an issue inside RStudio, please visit https://github.com/rstudio/rstudio
+        - If you're reporting an issue inside **Positron**, please visit https://github.com/posit-dev/positron
+        - If you want to ask for a feature, please use the [Feature Requests GitHub Discussions](https://github.com/quarto-dev/quarto-cli/discussions/categories/feature-requests).
+        - If you want to ask for help, please use the [Q&A GitHub Discussions](https://github.com/quarto-dev/quarto-cli/discussions/categories/q-a).
 
         Quarto is under active development!
         If convenient, we'd appreciate if you could check that the issue persists on the [latest pre-release](https://github.com/quarto-dev/quarto-cli/releases).
 
         Finally, so that we can get the most out of your bug report, consider reading our ["Bug Reports" guide](https://quarto.org/bug-reports.html).
 
-        If you want to ask for a feature, please use the [Feature Requests GitHub Discussions](https://github.com/quarto-dev/quarto-cli/discussions/categories/feature-requests).
-        If you want to ask for help, please use the [Q&A GitHub Discussions](https://github.com/quarto-dev/quarto-cli/discussions/categories/q-a).
-
         Thank you for using Quarto!
 
         ---
@@ -96,13 +96,13 @@ body:
 
   - type: textarea
     attributes:
-      label: Expected behavior
-      description: Tell us what should happen.
+      label: Actual behavior
+      description: Tell us what happens instead.
 
   - type: textarea
     attributes:
-      label: Actual behavior
-      description: Tell us what happens instead.
+      label: Expected behavior
+      description: Tell us what should happen.
 
   - type: textarea
     attributes:

.github/actions/cache-typst/action.yml

@@ -9,7 +9,7 @@ outputs:
     value: ${{ steps.cache-typst-restore.outputs.cache-primary-key }}
   cache-matched-key:
     description: "Key of the cache found and used."
-    value: ${{ steps.cache-typst-restore.outputs.cache-primary-key }}
+    value: ${{ steps.cache-typst-restore.outputs.cache-matched-key }}
   cache-path:
     description: "where is the packages cache for typst ?"
     value: ${{ steps.cache-typst-path.outputs.TYPST_CACHE }}
@@ -22,20 +22,21 @@ runs:
       run: |
         case $RUNNER_OS in
           "Linux")
-              echo "TYPST_CACHE=${XDG_CACHE_HOME:-~/.cache}/typst/packages/" >> $GITHUB_ENV
+              typst_cache="${XDG_CACHE_HOME:-~/.cache}/typst/packages/"
               ;;
           "macOS")
-              echo "TYPST_CACHE=~/Library/Caches/typst/packages/" >> $GITHUB_ENV
+              typst_cache="~/Library/Caches/typst/packages/"
               ;;
           "Windows")
-              echo "TYPST_CACHE=$LOCALAPPDATA/typst/packages/" >> $GITHUB_ENV
+              typst_cache="$LOCALAPPDATA/typst/packages/"
               ;;
             *)
               echo "$RUNNER_OS not supported"
               exit 1
               ;;
         esac
-        echo "TYPST_CACHE=${TYPST_CACHE}" >> $GITHUB_OUTPUT
+        echo "TYPST_CACHE=${typst_cache}" >> $GITHUB_ENV
+        echo "TYPST_CACHE=${typst_cache}" >> $GITHUB_OUTPUT
       shell: bash
 
     - name: Cache Typst package folder

.github/workflows/test-smokes.yml

@@ -105,14 +105,16 @@ jobs:
           cat("r-version=", R.Version()$version.string, "\n", file = Sys.getenv("GITHUB_OUTPUT"), sep = "", append = TRUE)
         shell: Rscript {0}
 
-      - name: Cache R packages
-        uses: actions/cache@v4
+      - name: Restore Renv package cache
+        id: cache-renv-packages-restore
+        uses: actions/cache/restore@v4
         with:
-          path: ${{ env.RENV_PATHS_ROOT }}
-          key: ${{ steps.get-version.outputs.os-version }}-${{ steps.get-version.outputs.r-version }}-renv-2-${{ hashFiles('tests/renv.lock') }}
+          path: |
+            ${{ env.RENV_PATHS_ROOT }}
+            renv/library
+          key: ${{ steps.get-version.outputs.os-version }}-${{ steps.get-version.outputs.r-version }}-renv-3-${{ hashFiles('tests/renv.lock') }}
           restore-keys: |
-            ${{ steps.get-version.outputs.os-version }}-${{ steps.get-version.outputs.r-version }}-renv-2-
-          save-always: ${{ inputs.extra-r-packages == '' }} # don't save cache if we have extra R packages
+            ${{ steps.get-version.outputs.os-version }}-${{ steps.get-version.outputs.r-version }}-renv-3-
 
       - name: Install missing system deps
         if: runner.os == 'Linux'
@@ -291,15 +293,25 @@ jobs:
           path: tests/timing-for-ci.txt
 
       - name: Save Typst cache
-        if: always()
+        if: always() && steps.cache-typst.outputs.cache-hit != 'true'
         uses: actions/cache/save@v4
         with:
           key: ${{ steps.cache-typst.outputs.cache-primary-key }}
           path: ${{ steps.cache-typst.outputs.cache-path }}
 
+      - name: Save Renv package cache
+        # don't save cache if we have extra R packages
+        if: ${{ always() && steps.cache-renv-packages-restore.outputs.cache-hit != 'true' && inputs.extra-r-packages == '' }}
+        uses: actions/cache/save@v4
+        with:
+          path: |
+            ${{ env.RENV_PATHS_ROOT }}
+            renv/library
+          key: ${{ steps.cache-renv-packages-restore.outputs.cache-primary-key }}
+
       - uses: actions/upload-artifact@v4
-        # PLaywright test only runs on Linux for now
-        if: ${{ !cancelled() && runner.os != 'Windows' }}
+        # Upload pLaywright test report if they exists (playwright is only running on Linux for now)
+        if: ${{ !cancelled() && runner.os != 'Windows' && hashFiles('tests/integration/playwright/playwright-report/**/*') != '' }}
         with:
           name: playwright-report
           path: ./tests/integration/playwright/playwright-report/

CONTRIBUTING.md

@@ -3,7 +3,7 @@
 You can contribute to Quarto in many ways:
 
 - By opening issues to provide feedback and share ideas.
-- By submitting Pull Request (PR) to fix opened issues
+- By submitting Pull Request (PR) to fix open issues
 - By submitting Pull Request (PR) to suggest new features (it is considered good practice to open an issue for discussion before working on a pull request for a new feature).
 
 Please be mindful of our [code of conduct](https://github.com/quarto-dev/quarto-cli/blob/main/.github/CODE_OF_CONDUCT.md) as you interact with other community members.
@@ -26,8 +26,8 @@ Pull requests are very welcome! Here's how to contribute via PR:
     $ git checkout -b feature/newthing
     ```
 
-2.  For significant changes (e.g more than small bug fixes), ensure that you have signed the [individual](https://posit.co/wp-content/uploads/2023/04/2023-03-13_TC_Indiv_contrib_agreement.pdf) or [corporate](https://posit.co/wp-content/uploads/2023/04/2023-03-13_TC_Corp_contrib_agreement.pdf) contributor agreement as appropriate. You can send the signed copy to [jj\@rstudio.com](mailto:[email protected]){.email}.
+2.  For significant changes (e.g., more than small bug fixes), ensure that you have signed the [individual](https://posit.co/wp-content/uploads/2023/04/2023-03-13_TC_Indiv_contrib_agreement.pdf) or [corporate](https://posit.co/wp-content/uploads/2023/04/2023-03-13_TC_Corp_contrib_agreement.pdf) contributor agreement as appropriate. You can send the signed copy to [jj\@rstudio.com](mailto:[email protected]){.email}.
 
-3.  Submit the [pull request](https://help.github.com/articles/using-pull-requests). It is ok to submit as draft in your are still working on it but would like some feedback from us. It always good to share in the open that you are working on it.
+3.  Submit the [pull request](https://help.github.com/articles/using-pull-requests). It is ok to submit as draft if your are still working on it but would like some feedback from us. It is always good to share in the open that you are working on it.
 
 We'll try to be as responsive as possible in reviewing and accepting pull requests.

README.md

@@ -2,25 +2,25 @@
 
 # Quarto
 
-Quarto is an open-source scientific and technical publishing system built on [Pandoc](https://pandoc.org). Quarto documents are authored using [markdown](https://en.wikipedia.org/wiki/Markdown), an easy to write plain text format.
+Quarto is an open-source scientific and technical publishing system built on [Pandoc](https://pandoc.org). Quarto documents are authored using [Markdown](https://en.wikipedia.org/wiki/Markdown), an easy to write plain text format.
 
 In addition to the core capabilities of Pandoc, Quarto includes:
 
 1.  Embedding code and output from Python, R, Julia, and JavaScript via integration with [Jupyter](https://jupyter.org/), [Knitr](https://yihui.org/knitr/), and [Observable](https://github.com/observablehq/).
 
-2.  A variety of extensions to Pandoc markdown useful for technical writing including cross-references, sub-figures, layout panels, hoverable citations and footnotes, callouts, and more.
+2.  A variety of extensions to Pandoc Markdown useful for technical writing including cross-references, sub-figures, layout panels, hoverable citations and footnotes, callouts, and more.
 
 3.  A project system for rendering groups of documents at once, sharing options across documents, and producing aggregate output like [websites](https://quarto.org/docs/websites/) and [books](https://quarto.org/docs/books/).
 
 4.  Authoring using a wide variety of editors and notebooks including [JupyterLab](https://quarto.org/docs/tools/jupyter-lab.html), [RStudio](https://quarto.org/docs/tools/rstudio.html), and [VS Code](https://quarto.org/docs/tools/vscode.html).
 
-5.  A [visual markdown editor](https://quarto.org/docs/visual-editor/) that provides a productive writing interface for composing long-form documents.
+5.  A [visual Markdown editor](https://quarto.org/docs/visual-editor/) that provides a productive writing interface for composing long-form documents.
 
 Learn more about Quarto at <https://quarto.org>.
 
 ## Development Version
 
-To install the development version of the Quarto CLI, clone the quarto-cli repository then run the configure script for your platform (`configure.sh` for Linux/macOS or `configure.cmd` for Windows). For example:
+To install the development version of the Quarto CLI, clone the `quarto-cli` repository then run the configure script for your platform (`configure.sh` for Linux/macOS or `configure.cmd` for Windows). For example:
 
 ```bash
 git clone https://github.com/quarto-dev/quarto-cli

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

@@ -0,0 +1,27 @@
+- [ ] ensure tests pass on stable branch
+  - Actions -> Parallel Smokes Tests -> Run Workflow ->
+    - Select the current stable branch in the "Use workflow from... v1.x" dropdown
+    - [ ] Click "Run Workflow"
+- [ ] create new stable installers
+  - Click Actions -> Build Installers -> "Run Workflow" Dropdown Menu
+    - Select the current stable branch in the "Use workflow from..." dropdown
+    - Uncheck "Pre-release" (or ensure it's unchecked)
+    - Check "Publish release" (or ensure it's checked)
+    - [ ] Click "Run Workflow"
+- [ ] update release on pypi repo
+  - 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 actions
+    - Select 'Publish Quarto PyPi'
+    - [ ] Click "Run Workflow"
+      - **Publishing Test**: You may elect to publish to test.pypi first by _unchecking_ the `Production Release` option
+        - Once complete, trest using
+          ```bash
+          python3 -m pip install --index-url https://test.pypi.org/ --extra-index-url https://pypi.org/ quarto-cli
+          ```
+        - You may have to run this command twice as the first time may report the package not found and cause cache invalidation. The next try should succeed.
+        - Published to: <https://test.pypi.org/project/quarto-cli/>
+      - **Publishing Production**: You may elect to publish to production pypyi by checking the `Production Release` option
+        - Published to: <https://pypi.org/project/quarto-cli/>
+    - Take a sip of tea ☕, bask in the glory of automation.
+- [ ] Update the stable changelog by moving entries to the "in previous release"