Skip to content

Remove header "latest ArchivesSpace release" badge in favor of prose on the Getting Started page that auto-updates when a new release is published#305

Merged
thimios merged 4 commits into
mainfrom
refactor-the-latest-release-info
Mar 30, 2026
Merged

Remove header "latest ArchivesSpace release" badge in favor of prose on the Getting Started page that auto-updates when a new release is published#305
thimios merged 4 commits into
mainfrom
refactor-the-latest-release-info

Conversation

@brianzelip

@brianzelip brianzelip commented Mar 30, 2026

Copy link
Copy Markdown
Collaborator

This PR removes the header “latest ArchivesSpace release” badge and replaces that UX with explicit prose on the Getting Started page.

It also introduces a new automation path so tech-docs can be updated when ArchivesSpace core publishes a release:

Core new release dispatch event ──► Tech Docs workflow
                                      │
                                      ├──► write to src/lib/latestArchivesSpaceRelease.ts
                                      │
                                      └──► open PR ──► human review & merge

System behavior

  1. Core publishes a non-prerelease release.
  2. Core workflow dispatches new-archivesspace-release event to Tech Docs with:
  • tag_name
  • html_url
  1. Tech Docs receives the dispatched event:
  • an Action is triggered when the repo receives the event
    • writes src/lib/latestArchivesSpaceRelease.ts
    • opens/updates a PR in tech-docs
  1. Human reviews/merges PR.

Changes made outside this repo

Next steps

[0] initiate a dry-run via the GitHub cli:

gh workflow run ".github/workflows/new-archivesspace-release.yml" \
  --ref tweak-new-archivesspace-release-workflow \
  -f tag_name=v4.2.0 \
  -f html_url=https://github.com/archivesspace/archivesspace/releases/tag/v4.2.0

References

- Rename getting_started.md -> .mdx to import the new component.
- Fix Getting Started page heading hierarchy errors and remove duplicate content.
This new design is based on a personal access token used to dispatch
a release event with a data payload from core to the Tech Docs. A new
Tech Docs workflow then writes the release data to file, commits, and
opens a PR for human review.
@brianzelip
brianzelip force-pushed the refactor-the-latest-release-info branch from b5d3750 to 98cfbe5 Compare March 30, 2026 16:44
@cloudflare-workers-and-pages

cloudflare-workers-and-pages Bot commented Mar 30, 2026

Copy link
Copy Markdown

Deploying archivesspace-tech-docs with  Cloudflare Pages  Cloudflare Pages

Latest commit: 98cfbe5
Status: ✅  Deploy successful!
Preview URL: https://6fb29bdf.archivesspace-tech-docs.pages.dev
Branch Preview URL: https://refactor-the-latest-release.archivesspace-tech-docs.pages.dev

View logs

@thimios
thimios merged commit 5206bc3 into main Mar 30, 2026
4 checks passed
@thimios
thimios deleted the refactor-the-latest-release-info branch March 30, 2026 18:10
@brianzelip brianzelip changed the title Remove header "latest ArchivesSpace release" badge in favor of prose on the Getting Started page Remove header "latest ArchivesSpace release" badge in favor of prose on the Getting Started page that gets dynamically updated when a new release is published Mar 30, 2026
@brianzelip brianzelip changed the title Remove header "latest ArchivesSpace release" badge in favor of prose on the Getting Started page that gets dynamically updated when a new release is published Remove header "latest ArchivesSpace release" badge in favor of prose on the Getting Started page that auto-updates when a new release is published Mar 30, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants