From 34f28d2891e33874c72d10c40195df152bad7fed Mon Sep 17 00:00:00 2001 From: casy Date: Thu, 2 Apr 2026 14:36:42 +0200 Subject: [PATCH] feat: switch documentation deployment to main branch - Update GitHub Actions workflow to use main branch - Update deployment script to check for main branch - Update README documentation references to main branch - Update tests badge to reference main branch --- .github/workflows/docs.yml | 6 +++--- README.md | 4 ++-- docs-deploy.sh | 6 +++--- 3 files changed, 8 insertions(+), 8 deletions(-) diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml index 19404d9..d831fd2 100644 --- a/.github/workflows/docs.yml +++ b/.github/workflows/docs.yml @@ -2,9 +2,9 @@ name: Deploy Documentation on: push: - branches: [ release ] + branches: [ main ] pull_request: - branches: [ release ] + branches: [ main ] permissions: contents: read @@ -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 diff --git a/README.md b/README.md index b75e6e9..31278b7 100644 --- a/README.md +++ b/README.md @@ -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) @@ -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 diff --git a/docs-deploy.sh b/docs-deploy.sh index 29902b1..6ea2398 100755 --- a/docs-deploy.sh +++ b/docs-deploy.sh @@ -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