From e6910f3d8c62ebd6773d29acd0c7ba794041bbdd Mon Sep 17 00:00:00 2001 From: Arun Babu Neelicattu Date: Sun, 25 Feb 2024 17:26:16 +0100 Subject: [PATCH] doc: rename master branch to main (#9022) --- docs/_index.md | 4 ++-- docs/contributing.md | 8 ++++---- docs/dependency-specification.md | 2 +- docs/plugins.md | 2 +- 4 files changed, 8 insertions(+), 8 deletions(-) diff --git a/docs/_index.md b/docs/_index.md index 7c074d4883f..8293d3f6eb1 100644 --- a/docs/_index.md +++ b/docs/_index.md @@ -85,7 +85,7 @@ Finally, `pipx` can install any valid [pip requirement spec](https://pip.pypa.io allows for installations of the development version from `git`, or even for local testing of pull requests: ```bash -pipx install --suffix @master git+https://github.com/python-poetry/poetry.git@master +pipx install --suffix @main git+https://github.com/python-poetry/poetry.git@main pipx install --suffix @pr1234 git+https://github.com/python-poetry/poetry.git@refs/pull/1234/head ``` @@ -182,7 +182,7 @@ curl -sSL https://install.python-poetry.org | POETRY_VERSION=1.2.0 python3 - You can also install Poetry from a `git` repository by using the `--git` option: ```bash -curl -sSL https://install.python-poetry.org | python3 - --git https://github.com/python-poetry/poetry.git@master +curl -sSL https://install.python-poetry.org | python3 - --git https://github.com/python-poetry/poetry.git@main ```` If you want to install different versions of Poetry in parallel, a good approach is the installation with pipx and suffix. diff --git a/docs/contributing.md b/docs/contributing.md index ecb69f7de34..791c4f684b6 100644 --- a/docs/contributing.md +++ b/docs/contributing.md @@ -191,7 +191,7 @@ base branch. A maintainer might ask you to ensure the branch is up-to-date prior (especially if there have been CI changes on the base branch), and will also ask you to fix any conflicts. {{% /note %}} -All pull requests, unless otherwise instructed, need to be first accepted into the `master` branch. Maintainers will +All pull requests, unless otherwise instructed, need to be first accepted into the `main` branch. Maintainers will generally decide if any backports to other branches are required, and carry them out as needed. ### Issue triage @@ -233,15 +233,15 @@ When trying to reproduce issues, you often want to use multiple versions of Poet ```sh pipx install --suffix @1.2.1 'poetry==1.2.1' pipx install --suffix @1.3.0rc1 'poetry==1.3.0rc1' -pipx install --suffix @master 'poetry @ git+https://github.com/python-poetry/poetry' +pipx install --suffix @main 'poetry @ git+https://github.com/python-poetry/poetry' pipx install --suffix @local '/path/to/local/clone/of/poetry' # now you can use any of the chosen versions of Poetry with their configured suffix, e.g. -poetry@master --version +poetry@main --version ``` {{% note %}} -Do not forget to `pipx upgrade poetry@master` before using it, to make sure you have the latest changes. +Do not forget to `pipx upgrade poetry@main` before using it, to make sure you have the latest changes. {{% /note %}} {{% note %}} diff --git a/docs/dependency-specification.md b/docs/dependency-specification.md index e3279a92c63..f8aaf57a866 100644 --- a/docs/dependency-specification.md +++ b/docs/dependency-specification.md @@ -132,7 +132,7 @@ requests = { git = "https://github.com/requests/requests.git" } ``` Since we haven’t specified any other information, -Poetry assumes that we intend to use the latest commit on the `master` branch +Poetry assumes that we intend to use the latest commit on the `main` branch to build our project. You can combine the `git` key with the `branch` key to use another branch. diff --git a/docs/plugins.md b/docs/plugins.md index d3af23ce363..cdd17e5a350 100644 --- a/docs/plugins.md +++ b/docs/plugins.md @@ -263,7 +263,7 @@ removing them, sometimes the signature of an internal method has to be changed. As the author of a plugin, you are probably testing your plugin against the latest release of Poetry. Additionally, you should consider testing against the latest release branch and the -master branch of Poetry and schedule a CI job that runs regularly even if you did not +main branch of Poetry and schedule a CI job that runs regularly even if you did not make any changes to your plugin. This way, you will notice internal changes that break your plugin immediately and can prepare for the next Poetry release.