Merge staging into prod (#993)

* Removing validmind version variable (#921)

* infra: Merge main into staging PRs created by staging deploy now indicate original PR# (#924)

* Updating main into staging workflow

* Testing branch versions

* Removing test file

* Fix Makefile help

* infra: Delete older PR preview comments from validate & execute flows (#932)

* Adding deletion of old preview comments back in

* Removing unused variable

* Adding same thing to notebooks

* Edit to notebook, should remove old comment

* hm

* Deleting test execution notebook

* ValidMind Platform releases: Exclude `admin-ui` from roundup listing page (#933)

* Exclude admin-ui from platform releases roundup

* Adjust

* Remove old variable usage

---------

Co-authored-by: Nik Richers <nik@validmind.ai>

* docs: Export findings (#939)

* Setup: Customize model findings layout

* Save point

* Save point

* Draft: Customize model finding layouts

* Setup: Export findings

* Draft: Export findings

* Export documentation > Export documents

* Editing

* Cleanup

* Proofread

* Filter

* Update API reference to use prod server (#938)

* Update API reference to use prod server

* Update Makefile for admin API as well

* docs: Export inventory (#943)

* Setup: Export inventory

* Draft: Export inventory

* Proofreading

* Oops

* docs: Updated Export findings (#944)

* Setup

* Proofread

* Testing pinned Quarto version

* docs: Customize Virtual Document Validator (#947)

* Set up: Manage regulations and policies

* WIP

* Customize VDV draft

* Edits: Check documentation for compliance

* Proofread

* Quick UI updates

* Pin a Quarto version specified in Action variables for our deployment workflows (#951)

* Testing pinned Quarto version

* Applying pinned Quarto version to other workflows

* Removing test notebook

* docs: Workflow Wait step time delta configuration (#954)

* Setup: Wait step time delta

* Editing

* Updating example screencap for Wait

* Remove login button and make related CSS modular (#949)

* Remove login button and make related CSS modular

* Make login link specific to profile

* Change scss/ to assets/style/ and update README.md

* Fix double space

* Check out .gitignore from main

* Minor README.md tweak

* One more minor README.md tweak

* Add missing backticks

* Fix Log In button for developer.css

* Minor edits

* Slight adjust to CSS in-progress message

---------

Co-authored-by: Beck <164545837+validbeck@users.noreply.github.com>

* docs: Updated "Manage model finding fields" (#958)

* Edit: DElete model findings

* Edit: Manage model finding fields

* Editing UI wording

* Editing...

* Editing......

* Proofreading

* Edit

* docs: Updated "Manage document templates" (#960)

* Draft: Delete document templates

* Edit: View document templates

* Wrapping up

* Stupid broken link

* Edit: VDV Findings > Observations (#962)

* docs: Update inventory & finding field views (#964)

* Edit: Manage model inventory fields

* Save point

* Edit: Manage model finding fields

* Cleanup

* Proofread

* Adjustments

* Final touch

* Fix bug in Makefile (#935)

* Bug bash: nrichers/sc 12201/disable algolia search on api reference pages (#968)

* Disable Algolia search on Public API reference page

* Fix stray comment indent

* docs: Add shared text blocks to YAML templates (#970)

* Setup: Add library blocks to YAML templates

* Save point

* Save point

* Tidying up

* docs & training: Virtual Document Validator, regulations & policies set up update (#973)

* Draft: Questions from PDF uploads

* Training: Setup for regulations & policies

* Save point

* Save point

* Draft: Administrator Fundamentals update

* Draft: Developer Fundamentals update

* Proofreading

* Hiding PDF upload for VDV (#975)

* Add system access requirements (#977)

* Add initial system access requirements topic

* Text edits

* More edits

* Fix incomplete sentence

* Basic version: Improve navigation for Python API and Public REST API (#966)

* Apply the basic fixes we agreed on

* Remove a:hover experiment

* Update .gitignore

* Underline specific links only

* Address review comments from Beck

* Final CSS tweak

* Update release_notes_check.py (#981)

* Enable release notes checks to post comment with instructions (#984)

* Update release_notes_check.yaml

* Update release_notes_check.py

* Edit: Remove info for add finding via doc section (#978)

* docs: Updated Workflows Approval Step info (#979)

* Edit: Approval step & condition instructions

* Update: Approval Step example

* Add Tidy Layout callout

* Bump versions to 25.10 & v2.9.5 + public release landing page improvements (#971)

* Bump release versions

* Add temporary branch ref

* Fix Makefile help

* Reorder all releases page, bump up length of descriptions shown

* Turn older releases into collapsible section

* Fix YAML

* Fix YAML again

* Add pagination style from release notes portal

* Add button for all feature highlights & add whitespace

* Wording tweak

* Run make get-source

* All releases page tweaks

* Fix broken links

* Change heading to Latest features for consistency

* Address Beck's sidebar suggestion

* Fix date in this repo, too

* Add whitespace before heading

* Remove the branch ref I had THREE reminders for to remove ... (#991)

---------

Co-authored-by: Beck <164545837+validbeck@users.noreply.github.com>
Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>

Author: 3 people

.github/scripts/release_notes_check.py

@@ -3,7 +3,7 @@
 import re
 
 import requests
-from github import Github
+from github import Auth, Github
 
 
 def get_pull_request_number(pr_url):
@@ -16,7 +16,8 @@ def get_pull_request_number(pr_url):
 
 
 def ci_check(pr_number, access_token):
-    g = Github(access_token)
+    auth = Auth.Token(access_token)
+    g = Github(auth=auth)
     # Get repository, pull request, and labels
     repo = g.get_repo(os.environ["GITHUB_REPOSITORY"])
     pr = repo.get_pull(pr_number)
@@ -53,7 +54,7 @@ def ci_check(pr_number, access_token):
         if release_notes_match:
             release_notes_text = release_notes_match.group(1).strip()
             if release_notes_text and release_notes_text != "<!--- REPLACE THIS COMMENT WITH YOUR DESCRIPTION --->":
-                comment = "Pull requests must include at least one of the required labels: `internal` (no release notes required), `highlight`, `enhancement`, `bug`, `deprecation`, `documentation`."
+                comment = "Pull requests must include at least one of the required labels: `internal` (no release notes required), `highlight`, `enhancement`, `bug`, `deprecation`, `documentation`. Except for `internal`, pull requests must also include a description in the release notes section."
                 pr.create_issue_comment(comment)
                 return False
         # Pull request has neither a label nor a description

.github/workflows/deploy-docs-prod.yaml

@@ -49,6 +49,8 @@ jobs:
 
       - name: Set up Quarto
         uses: quarto-dev/quarto-actions/setup@v2
+        with:
+          version: ${{ vars.QUARTO_VERSION }}
 
       - name: Setup R environment
         uses: ./.github/actions/setup-r

.github/workflows/deploy-docs-staging.yaml

@@ -49,6 +49,8 @@ jobs:
 
       - name: Set up Quarto
         uses: quarto-dev/quarto-actions/setup@v2
+        with:
+          version: ${{ vars.QUARTO_VERSION }}
 
       - name: Setup R environment
         uses: ./.github/actions/setup-r

.github/workflows/execute-pr-preview.yaml

@@ -50,6 +50,8 @@ jobs:
     - name: Set up Quarto
       if: steps.filter.outputs.notebooks == 'true'
       uses: quarto-dev/quarto-actions/setup@v2
+      with:
+        version: ${{ vars.QUARTO_VERSION }}
 
     # If yes then create the dev.env file for use in execution step
     - name: Create dev.env file
@@ -96,10 +98,26 @@ jobs:
       uses: actions/github-script@v6
       with:
         script: |
-          const base = 'https://docs-staging.validmind.ai/pr_previews/${{ github.head_ref }}';
+          const base = `https://docs-staging.validmind.ai/pr_previews/${{ github.head_ref }}`;
           const devUrl = `${base}/notebooks/EXECUTED/model_development/1-set_up_validmind.html`;
           const valUrl = `${base}/notebooks/EXECUTED/model_validation/1-set_up_validmind_for_validation.html`;
 
+          // Delete old preview comments
+          const { data: comments } = await github.rest.issues.listComments({
+            owner: context.repo.owner,
+            repo: context.repo.repo,
+            issue_number: context.issue.number,
+          });
+          for (const comment of comments) {
+            if (comment.user.login === 'github-actions[bot]' && comment.body.includes('## Execute training notebooks for PRs')) {
+              await github.rest.issues.deleteComment({
+                owner: context.repo.owner,
+                repo: context.repo.repo,
+                comment_id: comment.id,
+              });
+            }
+          }
+
           let comment = `## Execute training notebooks for PRs\n\n`;
           comment += `✓ INFO: Live previews are available —\n\n`;
           comment += `- [Open model development series](${devUrl})\n`;

.github/workflows/execute-prod.yaml

@@ -37,6 +37,8 @@ jobs:
 
       - name: Set up Quarto
         uses: quarto-dev/quarto-actions/setup@v2
+        with:
+          version: ${{ vars.QUARTO_VERSION }}
 
       - name: Create dev.env file
         id: create_dev_env

.github/workflows/execute-staging.yaml

@@ -37,6 +37,8 @@ jobs:
 
       - name: Set up Quarto
         uses: quarto-dev/quarto-actions/setup@v2
+        with:
+          version: ${{ vars.QUARTO_VERSION }}
 
       - name: Create dev.env file
         id: create_dev_env

.github/workflows/merge-main-into-staging.yaml

@@ -30,13 +30,29 @@ jobs:
         run: |
           git merge --no-ff origin/main
 
+      # NEW: detect the PR that triggered this push to main (if any)
+      - name: Determine source PR (if any)
+        id: source-pr
+        env:
+          GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        run: |
+          prs=$(gh api \
+            repos/${{ github.repository }}/commits/${{ github.sha }}/pulls \
+            -H "Accept: application/vnd.github+json")
+          number=$(echo "$prs" | jq -r '.[0].number // empty')
+          if [ -n "$number" ]; then
+            echo "prefix=PR#$number — " >> "$GITHUB_OUTPUT"
+          else
+            echo "prefix=" >> "$GITHUB_OUTPUT"
+          fi
+
       - name: Create pull request
         id: pr-number
         uses: peter-evans/create-pull-request@v5
         with:
           token: ${{ secrets.GITHUB_TOKEN }}
           branch: update-staging-${{ github.run_id }}
-          title: 'Merge main into staging'
+          title: '${{ steps.source-pr.outputs.prefix }}Merge main into staging'
           body: 'Automatically merge main into staging branch.'
 
       - name: Merge pull request (with retries)
@@ -54,4 +70,4 @@ jobs:
         if: ${{ success() && steps.pr-number.outputs.pull-request-number != '' }}
         run: gh api -X DELETE "repos/${{ github.repository }}/git/refs/heads/update-staging-${{ github.run_id }}"
         env:
-          GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}

.github/workflows/release_notes_check.yaml

@@ -6,7 +6,7 @@ on:
 
 permissions:
   contents: read
-  pull-requests: read
+  pull-requests: write
 
 jobs:
   ci_check:

.github/workflows/validate-docs-site.yaml

@@ -44,6 +44,8 @@ jobs:
 
     - name: Set up Quarto
       uses: quarto-dev/quarto-actions/setup@v2
+      with:
+        version: ${{ vars.QUARTO_VERSION }}
 
     - name: Setup R environment
       uses: ./.github/actions/setup-r
@@ -87,6 +89,22 @@ jobs:
         script: |
           const previewUrl = `https://docs-staging.validmind.ai/pr_previews/${{ github.head_ref }}/index.html`;
 
+          // Delete old preview comments
+          const { data: comments } = await github.rest.issues.listComments({
+            owner: context.repo.owner,
+            repo: context.repo.repo,
+            issue_number: context.issue.number,
+          });
+          for (const comment of comments) {
+            if (comment.user.login === 'github-actions[bot]' && comment.body.includes('## Validate docs site')) {
+              await github.rest.issues.deleteComment({
+                owner: context.repo.owner,
+                repo: context.repo.repo,
+                comment_id: comment.id,
+              });
+            }
+          }
+
           let comment = `## Validate docs site\n\n`;
           comment += `✓ INFO: A live preview of the docs site is available — [Open the preview](${previewUrl})\n\n`;
 
@@ -113,4 +131,4 @@ jobs:
 
     - name: Final disk usage
       if: always()
-      run: df -hT /
+      run: df -hT /

.vscode/settings.json

@@ -7,5 +7,8 @@
         "latex",
         "plaintext",
         "quarto"
-    ]
+    ],
+    "python-envs.defaultEnvManager": "ms-python.python:conda",
+    "python-envs.defaultPackageManager": "ms-python.python:conda",
+    "python-envs.pythonProjects": []
 }