Skip to content

Deploy release notes 26.06#1365

Merged
validbeck merged 6 commits into
prodfrom
staging
Jun 2, 2026
Merged

Deploy release notes 26.06#1365
validbeck merged 6 commits into
prodfrom
staging

Conversation

@validbeck
Copy link
Copy Markdown
Collaborator

Pull Request Description

What and why?

How to test

What needs special review?

Dependencies, breaking changes, and deployment notes

Release notes

Checklist

  • What and why
  • Screenshots or videos (Frontend)
  • How to test
  • What needs special review
  • Dependencies, breaking changes, and deployment notes
  • Labels applied
  • PR linked to Shortcut
  • Unit tests added (Backend)
  • Tested locally
  • Documentation updated (if required)
  • Environment variable additions/changes documented (if required)

validbeck and others added 6 commits June 2, 2026 11:02
…rimary-record-types-phase

docs: Models  > Records — Reporting, Monitoring, Attestation
* Add temporary release-notes branch ref for 26.06 preview

Points to nrichers/sc-16263/release-notes-for-26-06 branch in release-notes repo.

* Run make get-source

* Add subtitle to all-releases page listing

* refreshing vm-library

* cache invalidation

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

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

* REF FOR PREVIEW, REMOVE BEFORE MERGE

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

---------

Co-authored-by: Beck <164545837+validbeck@users.noreply.github.com>
@validbeck validbeck self-assigned this Jun 2, 2026
@validbeck validbeck added the internal Not to be externalized in the release notes label Jun 2, 2026
@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented Jun 2, 2026

PR Summary

This PR introduces two significant changes:

  1. GitHub Workflow Enhancements:

    • Updated the deployment scripts in the GitHub Actions workflows to add a cache-control header (no-cache, max-age=0, must-revalidate) to the AWS S3 sync commands. This will ensure that stale content is not served and forces clients to retrieve the latest versions after deployment.
    • Minor changes to AWS endpoint configuration in one of the notebooks have been updated from a localhost URL to a production URL, which helps in connecting to the correct API endpoint.
  2. Documentation and Terminology Updates:

    • Several markdown files and guide documents have been modified to replace generic "model" terminology with "record" (or a combination of "record (model)") where appropriate. This includes attestation guides, monitoring documents, reporting templates, training modules, and other learning resources.
    • The changes improve clarity and consistency across the documentation, ensuring that references to inventory, artifacts, attestations, and workflows correctly reflect the underlying model/record data.
    • Text for UI elements (e.g., register model pages, inventory fields) is updated to match this revised terminology.

Overall, the PR enhances the caching behavior during production deployment and aligns the documentation with updated business terminology, which should reduce potential confusion for users.

Test Suggestions

  • Run the GitHub workflows in a staging environment to verify that the cache-control header is applied in the S3 sync commands and that CloudFront invalidation is triggered properly.
  • Manually test deployment of documentation to ensure that excluded directories are still correctly omitted and that no caching issues occur in browsers.
  • Review several pages of the attestation, monitoring, and reporting guides to ensure that all instances of the outdated terminology are updated consistently.
  • Test notebooks that initialize API connections by confirming they now point to the production endpoint and use the updated credential placeholders.

@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented Jun 2, 2026

Validate docs site

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

@validbeck validbeck merged commit f03e3ed into prod Jun 2, 2026
7 of 8 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

internal Not to be externalized in the release notes

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants