From 2e2f8809b51150ead252ff06729647d8a93158a3 Mon Sep 17 00:00:00 2001 From: Nick Murphy Date: Mon, 12 Jan 2026 15:06:26 -0500 Subject: [PATCH 1/4] Rename branchs in workflow and conf.py --- .github/workflows/ci.yml | 2 +- conf.py | 4 ++-- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index 467dcc81..e666b9b5 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -3,7 +3,7 @@ name: CI on: push: branches: - - src + - main pull_request: workflow_dispatch: schedule: diff --git a/conf.py b/conf.py index a8736ab1..4a2b65dd 100644 --- a/conf.py +++ b/conf.py @@ -686,8 +686,8 @@ # For more details, read the manual: # https://getnikola.com/handbook.html#deploying-to-github # You will need to configure the deployment branch on GitHub. -GITHUB_SOURCE_BRANCH = "src" -GITHUB_DEPLOY_BRANCH = "main" +GITHUB_SOURCE_BRANCH = "main" +GITHUB_DEPLOY_BRANCH = "deploy" # The name of the remote where you wish to push to, using github_deploy. GITHUB_REMOTE_NAME = "origin" From 1b91170b37a9142f83e5b0ad82298a8584d700de Mon Sep 17 00:00:00 2001 From: Nick Murphy Date: Mon, 12 Jan 2026 15:08:36 -0500 Subject: [PATCH 2/4] Rename branch in deploy.yml --- .github/workflows/deploy.yml | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/.github/workflows/deploy.yml b/.github/workflows/deploy.yml index 173c9fd3..79300481 100644 --- a/.github/workflows/deploy.yml +++ b/.github/workflows/deploy.yml @@ -3,7 +3,7 @@ name: Build and deploy site on: push: branches: - - src + - main workflow_dispatch: jobs: @@ -11,8 +11,10 @@ jobs: runs-on: ubuntu-latest name: Deploy Nikola to GitHub Pages steps: + - name: Check out - uses: actions/checkout@v3 + uses: actions/checkout@v6 + - name: Build and Deploy Nikola uses: getnikola/nikola-action@v8 with: From b6a6b7c4a6f55bc346c474c8f0e6f3f2aa47b569 Mon Sep 17 00:00:00 2001 From: Nick Murphy Date: Mon, 12 Jan 2026 15:24:13 -0500 Subject: [PATCH 3/4] Update branch names --- CONTRIBUTING.md | 11 +++++++---- 1 file changed, 7 insertions(+), 4 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index e82bfd5d..5f1c729f 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -43,7 +43,10 @@ where *username* is your GitHub username. ### A note on branches -Nikola's source files are located on the `src` git branch, and the built HTML files are located on the `main` branch. The GitHub repository defaults to the source branch as default when cloning the repository, so you shouldn't need to worry about this - and you definitely do not need to change files on `main`. +Nikola's source files are located on the `main` git branch, and the built HTML files are located on the `deploy` branch. The GitHub repository defaults to the source branch as default when cloning the repository, so you shouldn't need to worry about this - and you definitely do not need to change files on `deploy`. + +> [!NOTE] +> In January 2026, the deployed branch was renamed from `main` to `deploy` and the source branch was renamed from `src` to `main` to align with common conventions. ## Submitting a code contribution @@ -54,12 +57,12 @@ Nikola's source files are located on the `src` git branch, and the built HTML fi ``` 2. Create and check out a branch based off of the - [`src`](https://github.com/PlasmaPy/plasmapy.github.io/tree/src) + [`main`](https://github.com/PlasmaPy/plasmapy.github.io/tree/main) branch of the upstream repository, and connect it to a new branch in your fork on GitHub. ```bash - git checkout -b new-branch-name upstream/src + git checkout -b new-branch-name upstream/main git push --set-upstream origin new-branch-name ``` @@ -79,7 +82,7 @@ Nikola's source files are located on the `src` git branch, and the built HTML fi nikola auto --browser 6. [Create a pull request](https://help.github.com/en/github/collaborating-with-issues-and-pull-requests/creating-a-pull-request) - to the `src` branch on the main repository. + to the `main` branch. 7. The website will be rebuilt automatically after the pull request is merged. After five to ten minutes, check that the website is functioning nominally. From 5be8126136c65ef5655dd25d3a02cc5b3ee9eda1 Mon Sep 17 00:00:00 2001 From: Nick Murphy Date: Mon, 12 Jan 2026 15:24:34 -0500 Subject: [PATCH 4/4] Minor updates and corrections --- CONTRIBUTING.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 5f1c729f..654326c1 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -66,17 +66,17 @@ Nikola's source files are located on the `main` git branch, and the built HTML f git push --set-upstream origin new-branch-name ``` -3. Make and commit changes in the `web/` directory. Most of the pages - are in `web/pages/` while blog posts are in `web/posts/`. +3. Make and commit changes in the `pages/` directory. Most of the pages + are in `pages/` while blog posts are in `web/posts/`. ```bash git add changed_file.md - git commit -m "Updated changed_file.md" + git commit -m "Update changed_file.md" ``` - Pages and posts are predominantly written in markdown, but [`nikola` supports various file formats](https://getnikola.com/handbook.html#supported-input-formats) like HTML, reStructuredText, etc. Please use the markdown format, unless it's absolutely necessary to use one of the others. + Pages and posts are written in [Markdown](https://www.markdownguide.org/). -4. Inside the `web/` directory, build and preview the website using +4. Build and preview the website using ```bash nikola auto --browser