Switch to RELEASE_NOTES_RO_PAT for installation repo by nrichers · Pull Request #1231 · validmind/documentation

nrichers · 2026-03-23T18:14:13Z

Pull Request Description

What and why?

Fixes failures due to a stale INSTALLATION_RO_PAT by switching to the same RELEASE_NOTES_RO_PAT we use for all other repos, now with RO access to the installation repo:

How to test

Proof it works: https://github.com/validmind/documentation/actions/runs/23453001219/job/68234794483?pr=1231

Run actions/checkout@v4
Syncing repository: validmind/installation
Getting Git version info
Temporarily overriding HOME='/home/runner/work/_temp/c4e0d74a-bb67-4098-87f0-6e1e402948ee' before making global git config changes
Adding repository directory to the temporary git global config as a safe directory
/usr/bin/git config --global --add safe.directory /home/runner/work/documentation/documentation/site/_source/installation
Initializing the repository
Disabling automatic garbage collection
Setting up auth
Determining the default branch
  Retrieving the default branch name
  Default branch 'main'
Fetching the repository
  /usr/bin/git -c protocol.version=2 fetch --no-tags --prune --no-recurse-submodules --filter=blob:none --depth=1 origin +refs/heads/main:refs/remotes/origin/main
  From https://github.com/validmind/installation
   * [new branch]      main       -> origin/main
Determining the checkout info
Setting up sparse checkout
Checking out the ref
  /usr/bin/git checkout --progress --force -B main refs/remotes/origin/main
  Updating files:   1% (1/52)
  Updating files:   3% (2/52)
  Updating files:   5% (3/52)
  Updating files:   7% (4/52)
  Updating files:   9% (5/52)
  Updating files:  11% (6/52)
  Updating files:  13% (7/52)
  Updating files:  15% (8/52)
  Updating files:  17% (9/52)
  Updating files:  19% (10/52)
  Updating files:  21% (11/52)
  Updating files:  23% (12/52)
  Updating files:  25% (13/52)
  Updating files:  26% (14/52)
  Updating files:  28% (15/52)
  Updating files:  30% (16/52)
  Updating files:  32% (17/52)
  Updating files:  34% (18/52)
  Updating files:  36% (19/52)
  Updating files:  38% (20/52)
  Updating files:  40% (21/52)
  Updating files:  42% (22/52)
  Updating files:  44% (23/52)
  Updating files:  46% (24/52)
  Updating files:  48% (25/52)
  Updating files:  50% (26/52)
  Updating files:  51% (27/52)
  Updating files:  53% (28/52)
  Updating files:  55% (29/52)
  Updating files:  57% (30/52)
  Updating files:  59% (31/52)
  Updating files:  61% (32/52)
  Updating files:  63% (33/52)
  Updating files:  65% (34/52)
  Updating files:  67% (35/52)
  Updating files:  69% (36/52)
  Updating files:  71% (37/52)
  Updating files:  73% (38/52)
  Updating files:  75% (39/52)
  Updating files:  76% (40/52)
  Updating files:  78% (41/52)
  Updating files:  80% (42/52)
  Updating files:  82% (43/52)
  Updating files:  84% (44/52)
  Updating files:  86% (45/52)
  Updating files:  88% (46/52)
  Updating files:  90% (47/52)
  Updating files:  92% (48/52)
  Updating files:  94% (49/52)
  Updating files:  96% (50/52)
  Updating files:  98% (51/52)
  Updating files: 100% (52/52)
  Updating files: 100% (52/52), done.
  Switched to a new branch 'main'
  branch 'main' set up to track 'origin/main'.
/usr/bin/git log -1 --format=%H
878e6107622ef9ec6258bff7e5d987e9aae2e1a3

What needs special review?

Dependencies, breaking changes, and deployment notes

Release notes

Checklist

github-actions · 2026-03-23T18:14:54Z

PR Summary

This pull request updates the token used in multiple GitHub workflow files for deploying documentation. Specifically, the secret token previously referenced as INSTALLATION_RO_PAT has been replaced by RELEASE_NOTES_RO_PAT in three workflow files:

.github/workflows/deploy-docs-prod.yaml
.github/workflows/deploy-docs-staging.yaml
.github/workflows/validate-docs-site.yaml

The change ensures that the workflows now use the correct token for accessing the repository, likely aligning with changes in the repository’s access requirements or secret management. These updates affect both the production and staging environments, as well as the documentation validation process by referencing the updated secret.

Test Suggestions

Validate that the workflows run successfully in the production environment using the updated secret.
Test the staging environment deployment to ensure proper execution with the new token.
Verify that the documentation validation workflow correctly pulls the repository using the new token.
Ensure the new secret (RELEASE_NOTES_RO_PAT) is properly configured in the repository settings.

github-actions · 2026-03-23T18:35:10Z

Validate docs site

✓ INFO: A live preview of the docs site is available — Open the preview

validbeck

🚢

github-actions · 2026-03-23T18:37:59Z

Lighthouse check results

⚠️ WARN: Average accessibility score is 0.87 (required: >0.9) — Check the workflow run

Show Lighthouse scores

Folder depth level checked: 0

Commit SHA: 4966d82

Modify the workflow to check a different depth:

0: Top-level navigation only — /index.html, /guide/guides.html, ...
1: All first-level subdirectories — /guide/.html, /developer/.html, ...
2: All second-level subdirectories — /guide/attestation/*.html, ...

Page	Accessibility	Performance	Best Practices	SEO
/developer/validmind-library.html	0.85	0.69	1.00	0.82
/get-started/get-started.html	0.85	0.71	1.00	0.73
/guide/guides.html	0.81	0.69	1.00	0.82
/index.html	0.93	0.62	1.00	0.82
/releases/all-releases.html	0.86	0.70	1.00	0.73
/support/support.html	0.91	0.68	1.00	0.82
/training/training.html	0.85	0.63	0.96	0.73

* Expand custom artifact type content * Add margin footnote link * Change to definition list * Edits * docs: Organization wide default tracking changes in content blocks (#1202) * Edit: Managing your organization * WIP: Collaborate with others > Tracking changes * Edit: Collaborate with others > Tracking changes * Proofread * docs: Insert inventory & artifact field values as variables into documents & library blocks (#1207) * Save point * Save point * Work with content blocks > Reference field values * Single-source prep * Editing * Save point * Save point * Save point * Edit * Editing... * New content editing toolbar image * Missing copyrights * docs: Individual model inventory field activity (#1206) * WIP: View model activity > Filter all model activity * Save point * View model activity: View individual model field activity * Save point * Save point * Save point * Proofreading * Proofreading again * Typo * Update site/guide/model-inventory/edit-model-inventory-fields.qmd Co-authored-by: Nik Richers <nik@validmind.ai> * Fixing numbering * Fixing indenting --------- Co-authored-by: Nik Richers <nik@validmind.ai> * feat: docs pipeline to render markdown * feat: bump quarto to pre-release * chore: run llm gen at the end so we don't delay pr previews * LUA filter + Pandoc post-processing experiment * docs: 'document' parameter in `vm.init()` for model document target (#1211) * WIP * Save point * Save point * Save point * Edit: Install & initialize the ValidMind Library * Cursor WIP * Save point * Save point * Save point * Save point * Save point * Store model credentials in env files * What's next * Updating notebook listing scripts for page-size: 4 * Save point * Quick edit * One more * and another * Hang on forgot training stuff * Updated get started * Updated enable monitoring * Training updated * copyright * Missed a module * feat: make llm publishing slimmer- no release no installation no library * chore: put vm-library llm docs back * Switch to sparse checkout for some repos * fix: errors in publish llm gha * chore: handle the case where branch name is not main or prod, for instance when testing * Add "Quick reference" section to test overview page (#1205) * Add key concepts section to test overview page * Make section a callout, change to quick reference * Save point for graphviz * Some graphviz tweaks * A few more tweaks * Fill colour tweak * Document vm_today and datetime support in calculated fields (#1167) * Document vm_today and datetime support in calculated fields Add collapsible example for date arithmetic in model inventory calculation fields: vm_today, date, datetime, timedelta, relativedelta. Includes next review date and days-remaining countdown examples. Notes timestamp input and string output behavior. [sc-7465] * Fix whitespace * Fix heading level and move inventory field types up one section * Add screenshots, edits after testing * Save point before moving content * Move into its own file and relocate * Better intro * Restore better vm_today example * Edits * Minor text reschuffle * Mention fields by name * Move field types reference content below prequisites and bump to h2 * Fix example casing * Consistency edit * Rename and restructure Supported Models page (#1163) * Rename and restructure Supported Models page - Rename supported-models.qmd to supported-model-frameworks.qmd - Add alias for old URL to preserve links - Restructure content into clearer sections: - Framework support with wrapper classes and install commands - Test input requirements (predict vs predict_proba) - Custom model wrappers (FunctionModel, PipelineModel) - GenAI and LLM support - RAG evaluation with RAGAS - Python and dependency compatibility - Add Mermaid diagrams for class hierarchy and test input flow - Update references in faq-integrations.qmd and overview-model-documentation.qmd * Fix missed sidebar update * Fix broken link * Add bridging sentence after callout * Re-add a what does supported mean heading * Minor edit * Re-add some old goodness * Much better detail * Edits * More edits * Edits * Remove old supported models page * Minor edit * Edits * File rename again * Remove duplicated embeddings content * Uncomment and move info about tests for text-generating models * Update site/developer/supported-models-and-frameworks.qmd Co-authored-by: Beck <164545837+validbeck@users.noreply.github.com> * Update site/developer/supported-models-and-frameworks.qmd Co-authored-by: Beck <164545837+validbeck@users.noreply.github.com> * Update site/developer/supported-models-and-frameworks.qmd Co-authored-by: Beck <164545837+validbeck@users.noreply.github.com> * Update site/developer/supported-models-and-frameworks.qmd Co-authored-by: Beck <164545837+validbeck@users.noreply.github.com> * Update site/developer/supported-models-and-frameworks.qmd Co-authored-by: Beck <164545837+validbeck@users.noreply.github.com> * Switch to definition list after removing lead-in text for bulleted list * Two columns for a neater layout * Remove pointless link * Add links, text edits * Update site/developer/supported-models-and-frameworks.qmd Co-authored-by: Beck <164545837+validbeck@users.noreply.github.com> * Whitespace * Address review comment from Juan * Remove links I'd added --------- Co-authored-by: Beck <164545837+validbeck@users.noreply.github.com> * docs: Updated document type names (#1224) * WIP * WIP * Editing validation report template def * Edit... * Glossary / about updated * FAQ updated * Quickstart -screenshots updated * Work with test results done * Enable monitoring done * Review monitoring results done * Work with metrics over time done * save point * save point * Editing Export documents * Export documents done * Glossary proofreading * Save point * Save point * Save point * Save point * Save point * Save point * Save point * Save point * Edit Manage document types * Edit Manage model documents * Edit Customize document templates * Edit Manage document templates * Edit Export documents * Edit * Edit * Quickstart - Register a model * Quickstart - Select a template * Quickstart - Work with {document} * Proofread * Pulling in latest notebooks * Removing unused page * Removing backup screenshots * Revert "Removing unused page" This reverts commit 9a710fd. * Revering a change that didn't make sense * Updating notebooks again * edit * docs: Delete and archive artifact types (#1228) * WIP * WIP * Edit: Manage artifact types * Edit * Edit after Slack convo * Add R support documentation (#1227) * Initial draft * Add more install info * Add quickstarts * Grouping install & initalize in sidebar * Silly sidebar variable quirk --------- Co-authored-by: Beck <164545837+validbeck@users.noreply.github.com> * Switch to RELEASE_NOTES_RO_PAT for installation repo (#1231) * Fix CI hang: Don't try to render Graphviz diagrams with GFM (#1230) * Add pandoc install step * Try chromium install since stuff renders fine locally * Switch to RELEASE_NOTES_RO_PAT for installation repo * Try images instead of Graphviz * Add render-llm make action for local testing * Remove Chromium install steps * BG transparency --------- Co-authored-by: Beck <164545837+validbeck@users.noreply.github.com> * Add auto-generated template schema documentation (#1166) * Add auto-generated template schema documentation - Create generate_template_schema_docs.py script to generate HTML schema docs from backend JSON Schema using json-schema-for-humans - Update customize-document-templates.qmd to use generated include - Add template schema and permissions documentation sections to README.md The template schema is now regenerated from the v5 JSON schema in the backend repo, replacing the outdated hardcoded HTML. Closes sc-6164 * Switch to {html} codeblock, move styles into separate file, style tweaks * Fixed whitespace issue and added rounded corners * Fix heading level * Delete generated template schema file * Add make action and move template schema docs generation into workflows * Minor edit * Fix style for No Additional Items badges * Kibosh wayward ellipsis * Remove permissions documentation section from my other PR * Strip out schema doc CSS that causes issues, style tweaks * Move expand and collapse buttons above first accordion * Smidgen of whitespace before embed * Add README.md section of required repos, remove old R info * Temporarily add Andres' branch ref * Switch to new UI schema JSON * Remove temporary branch ref * docs: Export analytics (#1225) * Setup: Export analytics * WIP * edit * Proofreading --------- 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> Co-authored-by: Spencer Krum <nibz@validmind.ai>

* Expand custom artifact type content * Add margin footnote link * Change to definition list * Edits * docs: Organization wide default tracking changes in content blocks (#1202) * Edit: Managing your organization * WIP: Collaborate with others > Tracking changes * Edit: Collaborate with others > Tracking changes * Proofread * docs: Insert inventory & artifact field values as variables into documents & library blocks (#1207) * Save point * Save point * Work with content blocks > Reference field values * Single-source prep * Editing * Save point * Save point * Save point * Edit * Editing... * New content editing toolbar image * Missing copyrights * docs: Individual model inventory field activity (#1206) * WIP: View model activity > Filter all model activity * Save point * View model activity: View individual model field activity * Save point * Save point * Save point * Proofreading * Proofreading again * Typo * Update site/guide/model-inventory/edit-model-inventory-fields.qmd * Fixing numbering * Fixing indenting --------- * feat: docs pipeline to render markdown * feat: bump quarto to pre-release * chore: run llm gen at the end so we don't delay pr previews * LUA filter + Pandoc post-processing experiment * docs: 'document' parameter in `vm.init()` for model document target (#1211) * WIP * Save point * Save point * Save point * Edit: Install & initialize the ValidMind Library * Cursor WIP * Save point * Save point * Save point * Save point * Save point * Store model credentials in env files * What's next * Updating notebook listing scripts for page-size: 4 * Save point * Quick edit * One more * and another * Hang on forgot training stuff * Updated get started * Updated enable monitoring * Training updated * copyright * Missed a module * feat: make llm publishing slimmer- no release no installation no library * chore: put vm-library llm docs back * Switch to sparse checkout for some repos * fix: errors in publish llm gha * chore: handle the case where branch name is not main or prod, for instance when testing * Add "Quick reference" section to test overview page (#1205) * Add key concepts section to test overview page * Make section a callout, change to quick reference * Save point for graphviz * Some graphviz tweaks * A few more tweaks * Fill colour tweak * Document vm_today and datetime support in calculated fields (#1167) * Document vm_today and datetime support in calculated fields Add collapsible example for date arithmetic in model inventory calculation fields: vm_today, date, datetime, timedelta, relativedelta. Includes next review date and days-remaining countdown examples. Notes timestamp input and string output behavior. [sc-7465] * Fix whitespace * Fix heading level and move inventory field types up one section * Add screenshots, edits after testing * Save point before moving content * Move into its own file and relocate * Better intro * Restore better vm_today example * Edits * Minor text reschuffle * Mention fields by name * Move field types reference content below prequisites and bump to h2 * Fix example casing * Consistency edit * Rename and restructure Supported Models page (#1163) * Rename and restructure Supported Models page - Rename supported-models.qmd to supported-model-frameworks.qmd - Add alias for old URL to preserve links - Restructure content into clearer sections: - Framework support with wrapper classes and install commands - Test input requirements (predict vs predict_proba) - Custom model wrappers (FunctionModel, PipelineModel) - GenAI and LLM support - RAG evaluation with RAGAS - Python and dependency compatibility - Add Mermaid diagrams for class hierarchy and test input flow - Update references in faq-integrations.qmd and overview-model-documentation.qmd * Fix missed sidebar update * Fix broken link * Add bridging sentence after callout * Re-add a what does supported mean heading * Minor edit * Re-add some old goodness * Much better detail * Edits * More edits * Edits * Remove old supported models page * Minor edit * Edits * File rename again * Remove duplicated embeddings content * Uncomment and move info about tests for text-generating models * Update site/developer/supported-models-and-frameworks.qmd * Update site/developer/supported-models-and-frameworks.qmd * Update site/developer/supported-models-and-frameworks.qmd * Update site/developer/supported-models-and-frameworks.qmd * Update site/developer/supported-models-and-frameworks.qmd * Switch to definition list after removing lead-in text for bulleted list * Two columns for a neater layout * Remove pointless link * Add links, text edits * Update site/developer/supported-models-and-frameworks.qmd * Whitespace * Address review comment from Juan * Remove links I'd added --------- * docs: Updated document type names (#1224) * WIP * WIP * Editing validation report template def * Edit... * Glossary / about updated * FAQ updated * Quickstart -screenshots updated * Work with test results done * Enable monitoring done * Review monitoring results done * Work with metrics over time done * save point * save point * Editing Export documents * Export documents done * Glossary proofreading * Save point * Save point * Save point * Save point * Save point * Save point * Save point * Save point * Edit Manage document types * Edit Manage model documents * Edit Customize document templates * Edit Manage document templates * Edit Export documents * Edit * Edit * Quickstart - Register a model * Quickstart - Select a template * Quickstart - Work with {document} * Proofread * Pulling in latest notebooks * Removing unused page * Removing backup screenshots * Revert "Removing unused page" This reverts commit 9a710fd. * Revering a change that didn't make sense * Updating notebooks again * edit * docs: Delete and archive artifact types (#1228) * WIP * WIP * Edit: Manage artifact types * Edit * Edit after Slack convo * Add R support documentation (#1227) * Initial draft * Add more install info * Add quickstarts * Grouping install & initalize in sidebar * Silly sidebar variable quirk --------- * Switch to RELEASE_NOTES_RO_PAT for installation repo (#1231) * Fix CI hang: Don't try to render Graphviz diagrams with GFM (#1230) * Add pandoc install step * Try chromium install since stuff renders fine locally * Switch to RELEASE_NOTES_RO_PAT for installation repo * Try images instead of Graphviz * Add render-llm make action for local testing * Remove Chromium install steps * BG transparency --------- * Add auto-generated template schema documentation (#1166) * Add auto-generated template schema documentation - Create generate_template_schema_docs.py script to generate HTML schema docs from backend JSON Schema using json-schema-for-humans - Update customize-document-templates.qmd to use generated include - Add template schema and permissions documentation sections to README.md The template schema is now regenerated from the v5 JSON schema in the backend repo, replacing the outdated hardcoded HTML. Closes sc-6164 * Switch to {html} codeblock, move styles into separate file, style tweaks * Fixed whitespace issue and added rounded corners * Fix heading level * Delete generated template schema file * Add make action and move template schema docs generation into workflows * Minor edit * Fix style for No Additional Items badges * Kibosh wayward ellipsis * Remove permissions documentation section from my other PR * Strip out schema doc CSS that causes issues, style tweaks * Move expand and collapse buttons above first accordion * Smidgen of whitespace before embed * Add README.md section of required repos, remove old R info * Temporarily add Andres' branch ref * Switch to new UI schema JSON * Remove temporary branch ref * docs: Export analytics (#1225) * Setup: Export analytics * WIP * edit * Proofreading --------- 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> Co-authored-by: Spencer Krum <nibz@validmind.ai>

Switch to RELEASE_NOTES_RO_PAT for installation repo

cb4f212

nrichers added the internal Not to be externalized in the release notes label Mar 23, 2026

nrichers requested a review from validbeck March 23, 2026 18:20

validbeck approved these changes Mar 23, 2026

View reviewed changes

nrichers merged commit 9634dbf into main Mar 23, 2026
10 checks passed

nrichers deleted the fix-PAT-failures branch March 23, 2026 19:14

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Switch to RELEASE_NOTES_RO_PAT for installation repo#1231

Switch to RELEASE_NOTES_RO_PAT for installation repo#1231
nrichers merged 1 commit intomainfrom
fix-PAT-failures

nrichers commented Mar 23, 2026 •

edited

Loading

Uh oh!

github-actions bot commented Mar 23, 2026

Uh oh!

github-actions bot commented Mar 23, 2026

Uh oh!

validbeck left a comment

Uh oh!

github-actions bot commented Mar 23, 2026

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Conversation

nrichers commented Mar 23, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Pull Request Description

What and why?

How to test

What needs special review?

Dependencies, breaking changes, and deployment notes

Release notes

Checklist

Uh oh!

github-actions bot commented Mar 23, 2026

PR Summary

Test Suggestions

Uh oh!

github-actions bot commented Mar 23, 2026

Validate docs site

Uh oh!

validbeck left a comment

Choose a reason for hiding this comment

Uh oh!

github-actions bot commented Mar 23, 2026

Lighthouse check results

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

nrichers commented Mar 23, 2026 •

edited

Loading