8000 Update `pgroll.com` docs versions on release by andrew-farries · Pull Request #737 · xataio/pgroll · GitHub
[go: up one dir, main page]
More Web Proxy on the site http://driver.im/
Skip to content

Update pgroll.com docs versions on release #737

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Mar 24, 2025

Conversation

andrew-farries
Copy link
Collaborator

Add a new step to the release job to:

  • Add a new doc version for the newly released version to the pgroll.com/docs site.
  • Update the latest link on the pgroll.com/docs site to point to the newly released version.

The PGROLL_COM_DATABASE_URL secret uses a role with the minimum set of permissions to update the doc_versions table to perform these actions.

@andrew-farries andrew-farries requested a review from Copilot March 24, 2025 09:55
@github-actions github-actions bot temporarily deployed to Docs Preview March 24, 2025 09:55 Inactive
Copy link
@Copilot Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull Request Overview

This PR updates the release workflow to add a step that updates the pgroll.com/docs site with a new documentation version and updates the "latest" link.

  • A step is added to set up the PostgreSQL client.
  • A step is added to run psql commands that insert a new doc version and update the "latest" tag.
Comments suppressed due to low confidence (1)

.github/workflows/build.yml:322

  • Consider adding the '-v ON_ERROR_STOP=1' flag here as well to ensure that the UPDATE command fails early on any SQL errors.
psql "$DATABASE_URL" -c "UPDATE doc_versions SET ref='${{ github.ref_name }}' WHERE version='latest'"

@andrew-farries andrew-farries marked this pull request as ready for review March 24, 2025 09:57
@andrew-farries andrew-farries requested review from SferaDev and kvch March 24, 2025 09:57
@andrew-farries andrew-farries merged commit a422b3f into main Mar 24, 2025
30 checks passed
@andrew-farries andrew-farries deleted the update-doc-versions-on-release branch March 24, 2025 15:35
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
0