From f16111632a19d3c2ec3ae4d0e6e2ac8021f2bb82 Mon Sep 17 00:00:00 2001 From: Philipp Schaefer <23384863+theoehrly@users.noreply.github.com> Date: Sun, 11 Jan 2026 17:35:06 +0100 Subject: [PATCH] MNT: rename master branch to main --- .github/workflows/docs.yml | 16 ++++++++-------- .github/workflows/selective_cache_persist.yml | 2 +- docs/contributing/contributing.rst | 4 ++-- docs/index.rst | 4 ++-- 4 files changed, 13 insertions(+), 13 deletions(-) diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml index cb9af55e5..61849a16e 100644 --- a/.github/workflows/docs.yml +++ b/.github/workflows/docs.yml @@ -31,7 +31,7 @@ on: type: string test-build: # does not use the versioning setup and only does a simple html build - # enables running on push to master when no access to secrets is available + # enables running on push to main when no access to secrets is available description: "Unversioned test build" required: false type: boolean @@ -40,7 +40,7 @@ on: types: [ released ] push: branches: - - master + - main paths: - 'src/docs/**' - 'src/fastf1/**' @@ -124,7 +124,7 @@ jobs: - name: Checkout currently deployed build output from external repo to build directory uses: actions/checkout@v5 # skip for pull requests (no access to secret + unversioned build is sufficient) - if: (!inputs.test-build) && ((github.event_name == 'release') || (github.ref == 'refs/heads/master') || (github.event_name == 'workflow_dispatch')) + if: (!inputs.test-build) && ((github.event_name == 'release') || (github.ref == 'refs/heads/main') || (github.event_name == 'workflow_dispatch')) with: repository: theOehrly/fastf1-doc-build-output path: docs/_build/html @@ -141,7 +141,7 @@ jobs: make version-build VERSION="${{ github.ref_name }}" # versioned build: release elif [[ "${{ github.event_name }}" == "workflow_dispatch" ]]; then make version-build # versioned build: dev - elif [[ "${{ github.ref }}" == "refs/heads/master" ]]; then + elif [[ "${{ github.ref }}" == "refs/heads/main" ]]; then make version-build # versioned build: dev else make html # unversioned build @@ -163,8 +163,8 @@ jobs: path: ./doc_cache - name: Push build changes to external repo - # If this was either a release, run manually with publish=true or a push to master - if: (!inputs.test-build) && ((github.event_name == 'release') || (github.ref == 'refs/heads/master') || inputs.publish) + # If this was either a release, run manually with publish=true or a push to main + if: (!inputs.test-build) && ((github.event_name == 'release') || (github.ref == 'refs/heads/main') || inputs.publish) uses: EndBug/add-and-commit@v9 with: cwd: "docs/_build/html" @@ -175,8 +175,8 @@ jobs: push: true deploy: - # deploy releases, dev builds on master and manual runs with publish=true - if: (!inputs.test-build) && ((github.event_name == 'release') || (github.ref == 'refs/heads/master') || inputs.publish) + # deploy releases, dev builds on main and manual runs with publish=true + if: (!inputs.test-build) && ((github.event_name == 'release') || (github.ref == 'refs/heads/main') || inputs.publish) name: Deploy Documentation # Add a dependency to the build job diff --git a/.github/workflows/selective_cache_persist.yml b/.github/workflows/selective_cache_persist.yml index 90ab56054..8e517c4dd 100644 --- a/.github/workflows/selective_cache_persist.yml +++ b/.github/workflows/selective_cache_persist.yml @@ -7,7 +7,7 @@ on: jobs: - access-fastf1-master-cache: + access-fastf1-main-cache: # Simply access the FastF1 cache for all runners of the test matrix without # modifying them to prevent GitHub from deleting the cache entries because # they have not been accessed. diff --git a/docs/contributing/contributing.rst b/docs/contributing/contributing.rst index 0126a05a3..e49808aa1 100644 --- a/docs/contributing/contributing.rst +++ b/docs/contributing/contributing.rst @@ -94,9 +94,9 @@ A brief overview is: 5. Create a branch to hold your changes:: - git checkout -b my-feature origin/master + git checkout -b my-feature origin/main - and start making changes. Never work in the ``master`` branch! + and start making changes. Never work in the ``main`` branch! 6. Work on this copy, on your computer, using Git to do the version control. When you're done editing e.g., ``fastf1/core.py``, do:: diff --git a/docs/index.rst b/docs/index.rst index 405cc0e99..d8554af82 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -164,11 +164,11 @@ me via email at oehrly@mailbox.org. Any requests to this address will be treated with confidentiality, if desired. **Do not use this email address for general support requests! Such requests will likely be ignored.** -FastF1 has a `Code of Conduct `_. +FastF1 has a `Code of Conduct `_. Complaints about a perceived breach of this code of conduct should be sent to oehrly@mailbox.org, in almost all cases. Please refer to the Code of Conduct, available through the main page of the GitHub repository (or click -`here `_), +`here `_), for information on how breaches are reported, how the Code of Conduct is enforced and what values FastF1 encourages.