Skip to content

feat: switch documentation deployment to main branch #19

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
cassymyo-spec merged 1 commit into from
Apr 3, 2026
+8 −8
Merged

feat: switch documentation deployment to main branch #19

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
6 changes: 3 additions & 3 deletions .github/workflows/docs.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,9 @@ name: Deploy Documentation

on:
push:
branches: [ release ]
branches: [ main ]
pull_request:
branches: [ release ]
branches: [ main ]

permissions:
contents: read
Expand Down Expand Up @@ -49,7 +49,7 @@ jobs:
url: ${{ steps.deployment.outputs.page_url }}
runs-on: ubuntu-latest
needs: build
if: github.ref == 'refs/heads/release'
if: github.ref == 'refs/heads/main'
steps:
- name: Deploy to GitHub Pages
id: deployment
Expand Down
4 changes: 2 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

# FiscGuy

[![Tests](https://github.com/digitaltouchcode/fisc/actions/workflows/tests.yml/badge.svg?branch=release)](https://github.com/digitaltouchcode/fisc/actions/workflows/tests.yml?query=branch%3Drelease)
[![Tests](https://github.com/digitaltouchcode/fisc/actions/workflows/tests.yml/badge.svg?branch=main)](https://github.com/digitaltouchcode/fisc/actions/workflows/tests.yml?query=branch%3Dmain)
[![PyPI version](https://img.shields.io/pypi/v/fiscguy.svg?v=1)](https://pypi.org/project/fiscguy/)
[![Downloads](https://static.pepy.tech/badge/fiscguy)](https://pepy.tech/project/fiscguy)
![Python](https://img.shields.io/badge/python-3.11%20|%203.12%20|%203.13-blue)
Expand Down Expand Up @@ -274,7 +274,7 @@ Our comprehensive documentation covers everything you need to know:

### 🌐 GitHub Pages Setup

This documentation is automatically deployed to GitHub Pages when you push to the `release` branch.
This documentation is automatically deployed to GitHub Pages when you push to the `main` branch.

**To enable GitHub Pages:**
1. Go to your repository Settings → Pages
Expand Down
6 changes: 3 additions & 3 deletions docs-deploy.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,9 +9,9 @@ echo ""

# Check if we're on the right branch
CURRENT_BRANCH=$(git branch --show-current)
if [ "$CURRENT_BRANCH" != "release" ]; then
echo " Warning: You're on branch '$CURRENT_BRANCH', not 'release'"
echo " Consider switching to release branch first"
if [ "$CURRENT_BRANCH" != "main" ]; then
echo " Warning: You're on branch '$CURRENT_BRANCH', not 'main'"
echo " Consider switching to main branch first"
echo ""
fi

Expand Down
Loading