Skip to content

Fix doc deploy #144

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.

Sign up for GitHub

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 2 commits into from
Oct 17, 2025
Merged

Fix doc deploy #144

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
d720282
Fix doc deployment
vitcpp Oct 16, 2025
c77b3cc
Set doc deployment on release publication
vitcpp Oct 16, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 5 additions & 5 deletions .github/workflows/deploy-docs.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
name: Build and Deploy Docs

# Deploy docs only for master
# Deploy docs when a new release is published or manually
on:
push:
branches:
- "master"
release:
types: [published]
workflow_dispatch:
Copy link
Contributor

@esabol esabol Oct 17, 2025

Choose a reason for hiding this comment

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

I'm all for adding workflow_dispatch:, but why are you removing the push: branches: - "master" lines?

Copy link
Contributor

@esabol esabol Oct 17, 2025 •
edited
Loading

Choose a reason for hiding this comment

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

Never mind. I get it. We want the docs to only update when there's a new release. May I suggest the following instead?

on:
  release:
    types: [published]
  workflow_dispatch:

That will trigger automatically only when a new release is published. In the context of a GitHub Actions workflow, "published" means that a release has been finalized and made visible to the public, or specifically, marked as a non-draft and non-prerelease version. This is distinct from simply saving a draft.

Reference: https://docs.github.com/en/actions/reference/workflows-and-actions/events-that-trigger-workflows#release


# Allow deployment to GitHub Pages
permissions:
Expand Down Expand Up @@ -48,4 +48,4 @@ jobs:

- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v2
uses: actions/deploy-pages@v4