From 36ebe91af78823860e4dc6c790f3f28507457016 Mon Sep 17 00:00:00 2001 From: Justin Mayer Date: Tue, 25 Jun 2024 11:33:28 +0200 Subject: [PATCH] Rename default branch to `main` --- .github/workflows/main.yml | 2 +- CONTRIBUTING.rst | 4 ++-- README.rst | 4 ++-- docs/settings.rst | 2 +- docs/themes.rst | 4 ++-- docs/tips.rst | 16 ++++++++-------- pelican/settings.py | 2 +- 7 files changed, 17 insertions(+), 17 deletions(-) diff --git a/.github/workflows/main.yml b/.github/workflows/main.yml index 4c0127dfd..e07caa722 100644 --- a/.github/workflows/main.yml +++ b/.github/workflows/main.yml @@ -110,7 +110,7 @@ jobs: environment: Deployment needs: [test, lint, docs, build] runs-on: ubuntu-latest - if: github.ref=='refs/heads/master' && github.event_name!='pull_request' && github.repository == 'getpelican/pelican' + if: github.ref=='refs/heads/main' && github.event_name!='pull_request' && github.repository == 'getpelican/pelican' permissions: contents: write diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst index 4faace911..5ac5f0ad9 100644 --- a/CONTRIBUTING.rst +++ b/CONTRIBUTING.rst @@ -24,7 +24,7 @@ Before you ask for help, please make sure you do the following: 3. Try reproducing the issue in a clean environment, ensuring you are using: -* latest Pelican release (or an up-to-date Git clone of Pelican master) +* latest Pelican release (or an up-to-date Git clone of Pelican ``main`` branch) * latest releases of libraries used by Pelican * no plugins or only those related to the issue @@ -87,7 +87,7 @@ Using Git and GitHub -------------------- * `Create a new branch`_ specific to your change (as opposed to making - your commits in the master branch). + your commits in the ``main`` branch). * **Don't put multiple unrelated fixes/features in the same branch / pull request.** For example, if you're working on a new feature and find a bugfix that doesn't *require* your new feature, **make a new distinct branch and pull diff --git a/README.rst b/README.rst index 3f708242a..0e3577ec8 100644 --- a/README.rst +++ b/README.rst @@ -64,8 +64,8 @@ Why the name “Pelican”? .. _`Pelican's internals`: https://docs.getpelican.com/en/latest/internals.html .. _`hosted on GitHub`: https://github.com/getpelican/pelican -.. |build-status| image:: https://img.shields.io/github/actions/workflow/status/getpelican/pelican/main.yml?branch=master - :target: https://github.com/getpelican/pelican/actions/workflows/main.yml?query=branch%3Amaster +.. |build-status| image:: https://img.shields.io/github/actions/workflow/status/getpelican/pelican/main.yml?branch=main + :target: https://github.com/getpelican/pelican/actions/workflows/main.yml?query=branch%3Amain :alt: GitHub Actions CI: continuous integration status .. |pypi-version| image:: https://img.shields.io/pypi/v/pelican.svg :target: https://pypi.org/project/pelican/ diff --git a/docs/settings.rst b/docs/settings.rst index 4ae608c6b..7269c0bd2 100644 --- a/docs/settings.rst +++ b/docs/settings.rst @@ -28,7 +28,7 @@ Environment variables can also be used here but must be escaped appropriately:: Settings are configured in the form of a Python module (a file). There is an `example settings file -`_ +`_ available for reference. To see a list of current settings in your environment, including both default diff --git a/docs/themes.rst b/docs/themes.rst index 2e01ec8eb..ace5dcb92 100644 --- a/docs/themes.rst +++ b/docs/themes.rst @@ -17,7 +17,7 @@ To generate its HTML output, Pelican uses the `Jinja `_ templating engine due to its flexibility and straightforward syntax. If you want to create your own theme, feel free to take inspiration from the `"simple" theme -`_. +`_. To generate your site using a theme you have created (or downloaded manually and then modified), you can specify that theme via the ``-t`` flag:: @@ -368,7 +368,7 @@ period_num A tuple of the form (``year``, ``month``, ``day``), You can see an example of how to use `period` in the `"simple" theme period_archives.html template -`_. +`_. .. _period_archives_variable: diff --git a/docs/tips.rst b/docs/tips.rst index 1398ccd9f..e5574c7ca 100644 --- a/docs/tips.rst +++ b/docs/tips.rst @@ -89,18 +89,18 @@ Publishing a User Site to GitHub Pages from a Branch ---------------------------------------------------- To publish a Pelican site in the form of User Pages, you need to *push* the -content of the ``output`` dir generated by Pelican to the ``master`` branch of +content of the ``output`` dir generated by Pelican to the ``main`` branch of your ``.github.io`` repository on GitHub. Again, you can take advantage of ``ghp-import``:: $ pelican content -o output -s pelicanconf.py $ ghp-import output -b gh-pages - $ git push git@github.com:elemoine/elemoine.github.io.git gh-pages:master + $ git push git@github.com:elemoine/elemoine.github.io.git gh-pages:main The ``git push`` command pushes the local ``gh-pages`` branch (freshly updated by the ``ghp-import`` command) to the ``elemoine.github.io`` repository's -``master`` branch on GitHub. +``main`` branch on GitHub. .. note:: @@ -116,10 +116,10 @@ inside the ``Pelican`` folder you can run:: $ pelican content -o .. -s pelicanconf.py -Now you can push the whole project ``.github.io`` to the master +Now you can push the whole project ``.github.io`` to the main branch of your GitHub repository:: - $ git push origin master + $ git push origin main (assuming origin is set to your remote repository). @@ -127,7 +127,7 @@ Publishing to GitHub Pages Using a Custom GitHub Actions Workflow ----------------------------------------------------------------- Pelican-powered sites can be published to GitHub Pages via a `custom workflow -`_. +`_. To use it: 1. Enable GitHub Pages in your repo: go to **Settings → Pages** and choose @@ -144,7 +144,7 @@ To use it: workflow_dispatch: jobs: deploy: - uses: "getpelican/pelican/.github/workflows/github_pages.yml@master" + uses: "getpelican/pelican/.github/workflows/github_pages.yml@main" permissions: contents: "read" pages: "write" @@ -152,7 +152,7 @@ To use it: with: settings: "publishconf.py" - You may want to replace the ``@master`` with the ID of a specific commit in + You may want to replace the ``@main`` with the ID of a specific commit in this repo in order to pin the version of the reusable workflow that you're using: ``uses: getpelican/pelican/.github/workflows/github_pages.yml@``. If you do this you might want to get Dependabot to send you automated pull diff --git a/pelican/settings.py b/pelican/settings.py index 46b761a51..66d6beeb2 100644 --- a/pelican/settings.py +++ b/pelican/settings.py @@ -347,7 +347,7 @@ def handle_deprecated_settings(settings: Settings) -> Settings: "FILES_TO_COPY", "STATIC_PATHS and EXTRA_PATH_METADATA", "https://github.com/getpelican/pelican/" - "blob/master/docs/settings.rst#path-metadata", + "blob/main/docs/settings.rst#path-metadata", ), ]: if old in settings: