Skip to content

fix: deploy docs only on release tags so the published version is clean #97

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
97gamjak merged 1 commit into from
Sep 13, 2026
Merged

fix: deploy docs only on release tags so the published version is clean #97

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
9 changes: 8 additions & 1 deletion .github/workflows/docs.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,8 @@ on:
branches:
- main
- dev
tags:
- "*.*.*"
paths:
- "docs/**"
- "src/**"
Expand Down Expand Up @@ -60,7 +62,12 @@ jobs:
path: docs/build/html

deploy:
if: github.event_name != 'pull_request' && github.ref == 'refs/heads/main'
# Only deploy from an actual release tag: setuptools_scm only produces a
# clean version (e.g. "0.1.2") when building from the exact tagged
# commit. Building from a branch push resolves to a dev version (e.g.
# "0.1.2.dev0+g...") because the release tag doesn't exist yet at
# merge time - it's created by a later step in create-tag.yml.
if: github.event_name == 'push' && startsWith(github.ref, 'refs/tags/')
needs: build
runs-on: ubuntu-latest
environment:
Expand Down
7 changes: 7 additions & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,13 @@ All notable changes to this project will be documented in this file.

## Next Release

### Bug Fixes

#### Documentation

- Only deploy documentation to GitHub Pages on release tag pushes, so the published version reflects the clean release version (e.g. `0.1.2`) instead of a dev version (e.g. `0.1.2.dev0+g...`)
- Add `docs` status badge to the README

<!-- insertion marker -->
## [0.1.2](https://github.com/repo/owner/releases/tag/0.1.2) - 2026-09-13

Expand Down
3 changes: 2 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
# DevOps

[![pytest](https://github.com/97gamjak/devops/actions/workflows/pytest.yml/badge.svg)](https://github.com/97gamjak/devops/actions/workflows/pytest.yml)
[![codecov](https://codecov.io/gh/97gamjak/devops/graph/badge.svg?token=yqdcZCNRzK)](https://codecov.io/gh/97gamjak/devops)
[![codecov](https://codecov.io/gh/97gamjak/devops/graph/badge.svg?token=yqdcZCNRzK)](https://codecov.io/gh/97gamjak/devops)
[![docs](https://github.com/97gamjak/devops/actions/workflows/docs.yml/badge.svg)](https://97gamjak.github.io/devops/)
Loading