mirror of
https://github.com/certbot/certbot.git
synced 2026-08-01 18:56:55 +02:00
Migrate master branch to main
We're a few years behind the curve on this one, but using "master" as a programming term is a callous practice that explicitly uses the historical institution of slavery as a cheap, racist metaphor. Switch to using "main", as it's the new default in git and GitHub.
This commit is contained in:
@@ -1,8 +1,8 @@
|
|||||||
# Configuring Azure Pipelines with Certbot
|
# Configuring Azure Pipelines with Certbot
|
||||||
|
|
||||||
Let's begin. All pipelines are defined in `.azure-pipelines`. Currently there are two:
|
Let's begin. All pipelines are defined in `.azure-pipelines`. Currently there are two:
|
||||||
* `.azure-pipelines/main.yml` is the main one, executed on PRs for master, and pushes to master,
|
* `.azure-pipelines/main.yml` is the main one, executed on PRs for main, and pushes to main,
|
||||||
* `.azure-pipelines/advanced.yml` add installer testing on top of the main pipeline, and is executed for `test-*` branches, release branches, and nightly run for master.
|
* `.azure-pipelines/advanced.yml` add installer testing on top of the main pipeline, and is executed for `test-*` branches, release branches, and nightly run for main.
|
||||||
|
|
||||||
Several templates are defined in `.azure-pipelines/templates`. These YAML files aggregate common jobs configuration that can be reused in several pipelines.
|
Several templates are defined in `.azure-pipelines/templates`. These YAML files aggregate common jobs configuration that can be reused in several pipelines.
|
||||||
|
|
||||||
@@ -64,7 +64,7 @@ Azure Pipeline needs RW on code, RO on metadata, RW on checks, commit statuses,
|
|||||||
RW access here is required to allow update of the pipelines YAML files from Azure DevOps interface, and to
|
RW access here is required to allow update of the pipelines YAML files from Azure DevOps interface, and to
|
||||||
update the status of builds and PRs on GitHub side when Azure Pipelines are triggered.
|
update the status of builds and PRs on GitHub side when Azure Pipelines are triggered.
|
||||||
Note however that no admin access is defined here: this means that Azure Pipelines cannot do anything with
|
Note however that no admin access is defined here: this means that Azure Pipelines cannot do anything with
|
||||||
protected branches, like master, and cannot modify the security context around this on GitHub.
|
protected branches, like main, and cannot modify the security context around this on GitHub.
|
||||||
Access can be defined for all or only selected repositories, which is nice.
|
Access can be defined for all or only selected repositories, which is nice.
|
||||||
```
|
```
|
||||||
|
|
||||||
@@ -91,11 +91,11 @@ grant permissions from Azure Pipelines to GitHub in order to setup a GitHub OAut
|
|||||||
then are way too large (admin level on almost everything), while the classic approach does not add any more
|
then are way too large (admin level on almost everything), while the classic approach does not add any more
|
||||||
permissions, and works perfectly well.__
|
permissions, and works perfectly well.__
|
||||||
|
|
||||||
- Select GitHub in "Select your repository section", choose certbot/certbot in Repository, master in default branch.
|
- Select GitHub in "Select your repository section", choose certbot/certbot in Repository, main in default branch.
|
||||||
- Click on YAML option for "Select a template"
|
- Click on YAML option for "Select a template"
|
||||||
- Choose a name for the pipeline (eg. test-pipeline), and browse to the actual pipeline YAML definition in the
|
- Choose a name for the pipeline (eg. test-pipeline), and browse to the actual pipeline YAML definition in the
|
||||||
"YAML file path" input (eg. `.azure-pipelines/test-pipeline.yml`)
|
"YAML file path" input (eg. `.azure-pipelines/test-pipeline.yml`)
|
||||||
- Click "Save & queue", choose the master branch to build the first pipeline, and click "Save and run" button.
|
- Click "Save & queue", choose the main branch to build the first pipeline, and click "Save and run" button.
|
||||||
|
|
||||||
_Done. Pipeline is operational. Repeat to add more pipelines from existing YAML files in `.azure-pipelines`._
|
_Done. Pipeline is operational. Repeat to add more pipelines from existing YAML files in `.azure-pipelines`._
|
||||||
|
|
||||||
|
|||||||
@@ -1,9 +1,9 @@
|
|||||||
# We run the test suite on commits to master so codecov gets coverage data
|
# We run the test suite on commits to main so codecov gets coverage data
|
||||||
# about the master branch and can use it to track coverage changes.
|
# about the main branch and can use it to track coverage changes.
|
||||||
trigger:
|
trigger:
|
||||||
- master
|
- main
|
||||||
pr:
|
pr:
|
||||||
- master
|
- main
|
||||||
- '*.x'
|
- '*.x'
|
||||||
|
|
||||||
variables:
|
variables:
|
||||||
|
|||||||
@@ -1,4 +1,4 @@
|
|||||||
# Nightly pipeline running each day for master.
|
# Nightly pipeline running each day for main.
|
||||||
trigger: none
|
trigger: none
|
||||||
pr: none
|
pr: none
|
||||||
schedules:
|
schedules:
|
||||||
@@ -6,7 +6,7 @@ schedules:
|
|||||||
displayName: Nightly build
|
displayName: Nightly build
|
||||||
branches:
|
branches:
|
||||||
include:
|
include:
|
||||||
- master
|
- main
|
||||||
always: true
|
always: true
|
||||||
|
|
||||||
variables:
|
variables:
|
||||||
|
|||||||
@@ -1,6 +1,6 @@
|
|||||||
## Pull Request Checklist
|
## Pull Request Checklist
|
||||||
|
|
||||||
- [ ] The Certbot team has recently expressed interest in reviewing a PR for this. If not, this PR may be closed due our limited resources and need to prioritize how we spend them.
|
- [ ] The Certbot team has recently expressed interest in reviewing a PR for this. If not, this PR may be closed due our limited resources and need to prioritize how we spend them.
|
||||||
- [ ] If the change being made is to a [distributed component](https://certbot.eff.org/docs/contributing.html#code-components-and-layout), edit the `master` section of `certbot/CHANGELOG.md` to include a description of the change being made.
|
- [ ] If the change being made is to a [distributed component](https://certbot.eff.org/docs/contributing.html#code-components-and-layout), edit the `main` section of `certbot/CHANGELOG.md` to include a description of the change being made.
|
||||||
- [ ] Add or update any documentation as needed to support the changes in this PR.
|
- [ ] Add or update any documentation as needed to support the changes in this PR.
|
||||||
- [ ] Include your name in `AUTHORS.md` if you like.
|
- [ ] Include your name in `AUTHORS.md` if you like.
|
||||||
|
|||||||
@@ -11,11 +11,11 @@ jobs:
|
|||||||
if: github.event.pull_request.merged == true && !github.event.pull_request.head.repo.fork
|
if: github.event.pull_request.merged == true && !github.event.pull_request.head.repo.fork
|
||||||
runs-on: ubuntu-latest
|
runs-on: ubuntu-latest
|
||||||
steps:
|
steps:
|
||||||
- uses: mattermost/action-mattermost-notify@master
|
- uses: mattermost/action-mattermost-notify@main
|
||||||
with:
|
with:
|
||||||
MATTERMOST_WEBHOOK_URL: ${{ secrets.MATTERMOST_MERGE_WEBHOOK }}
|
MATTERMOST_WEBHOOK_URL: ${{ secrets.MATTERMOST_MERGE_WEBHOOK }}
|
||||||
TEXT: >
|
TEXT: >
|
||||||
[${{ github.repository }}] |
|
[${{ github.repository }}] |
|
||||||
[${{ github.event.pull_request.title }}
|
[${{ github.event.pull_request.title }}
|
||||||
#${{ github.event.number }}](https://github.com/${{ github.repository }}/pull/${{ github.event.number }})
|
#${{ github.event.number }}](https://github.com/${{ github.repository }}/pull/${{ github.event.number }})
|
||||||
was merged into master by ${{ github.actor }}
|
was merged into main by ${{ github.actor }}
|
||||||
|
|||||||
@@ -15,7 +15,7 @@ jobs:
|
|||||||
DATE=$(date --date="7 days ago" +"%Y-%m-%d")
|
DATE=$(date --date="7 days ago" +"%Y-%m-%d")
|
||||||
echo "MERGED_URL=https://github.com/pulls?q=merged%3A%3E${DATE}+org%3Acertbot" >> $GITHUB_ENV
|
echo "MERGED_URL=https://github.com/pulls?q=merged%3A%3E${DATE}+org%3Acertbot" >> $GITHUB_ENV
|
||||||
echo "UPDATED_URL=https://github.com/pulls?q=updated%3A%3E${DATE}+org%3Acertbot" >> $GITHUB_ENV
|
echo "UPDATED_URL=https://github.com/pulls?q=updated%3A%3E${DATE}+org%3Acertbot" >> $GITHUB_ENV
|
||||||
- uses: mattermost/action-mattermost-notify@master
|
- uses: mattermost/action-mattermost-notify@main
|
||||||
with:
|
with:
|
||||||
MATTERMOST_WEBHOOK_URL: ${{ secrets.MATTERMOST_WEBHOOK_URL }}
|
MATTERMOST_WEBHOOK_URL: ${{ secrets.MATTERMOST_WEBHOOK_URL }}
|
||||||
MATTERMOST_CHANNEL: private-certbot
|
MATTERMOST_CHANNEL: private-certbot
|
||||||
|
|||||||
@@ -2,7 +2,7 @@
|
|||||||
|
|
||||||
Certbot adheres to [Semantic Versioning](https://semver.org/).
|
Certbot adheres to [Semantic Versioning](https://semver.org/).
|
||||||
|
|
||||||
## 3.0.0 - master
|
## 3.0.0 - main
|
||||||
|
|
||||||
### Added
|
### Added
|
||||||
|
|
||||||
|
|||||||
+3
-3
@@ -2,11 +2,11 @@
|
|||||||
|
|
||||||
|build-status|
|
|build-status|
|
||||||
|
|
||||||
.. |build-status| image:: https://img.shields.io/azure-devops/build/certbot/ba534f81-a483-4b9b-9b4e-a60bec8fee72/5/master
|
.. |build-status| image:: https://img.shields.io/azure-devops/build/certbot/ba534f81-a483-4b9b-9b4e-a60bec8fee72/5/main
|
||||||
:target: https://dev.azure.com/certbot/certbot/_build?definitionId=5
|
:target: https://dev.azure.com/certbot/certbot/_build?definitionId=5
|
||||||
:alt: Azure Pipelines CI status
|
:alt: Azure Pipelines CI status
|
||||||
|
|
||||||
.. image:: https://raw.githubusercontent.com/EFForg/design/master/logos/eff-certbot-lockup.png
|
.. image:: https://raw.githubusercontent.com/EFForg/design/main/logos/eff-certbot-lockup.png
|
||||||
:width: 200
|
:width: 200
|
||||||
:alt: EFF Certbot Logo
|
:alt: EFF Certbot Logo
|
||||||
|
|
||||||
@@ -39,7 +39,7 @@ Documentation: https://certbot.eff.org/docs
|
|||||||
|
|
||||||
Software project: https://github.com/certbot/certbot
|
Software project: https://github.com/certbot/certbot
|
||||||
|
|
||||||
Changelog: https://github.com/certbot/certbot/blob/master/certbot/CHANGELOG.md
|
Changelog: https://github.com/certbot/certbot/blob/main/certbot/CHANGELOG.md
|
||||||
|
|
||||||
For Contributors: https://certbot.eff.org/docs/contributing.html
|
For Contributors: https://certbot.eff.org/docs/contributing.html
|
||||||
|
|
||||||
|
|||||||
@@ -258,8 +258,8 @@ certificate once it is issued. Some plugins, like the built-in Apache and Nginx
|
|||||||
plugins, implement both interfaces and perform both tasks. Others, like the
|
plugins, implement both interfaces and perform both tasks. Others, like the
|
||||||
built-in Standalone authenticator, implement just one interface.
|
built-in Standalone authenticator, implement just one interface.
|
||||||
|
|
||||||
.. _interfaces.py: https://github.com/certbot/certbot/blob/master/certbot/certbot/interfaces.py
|
.. _interfaces.py: https://github.com/certbot/certbot/blob/main/certbot/certbot/interfaces.py
|
||||||
.. _plugins/common.py: https://github.com/certbot/certbot/blob/master/certbot/certbot/plugins/common.py#L45
|
.. _plugins/common.py: https://github.com/certbot/certbot/blob/main/certbot/certbot/plugins/common.py#L45
|
||||||
|
|
||||||
|
|
||||||
Authenticators
|
Authenticators
|
||||||
@@ -389,7 +389,7 @@ identifier ``metadata-1``.
|
|||||||
|
|
||||||
The script used to generate the snapcraft.yaml files for our own externally
|
The script used to generate the snapcraft.yaml files for our own externally
|
||||||
snapped plugins can be found at
|
snapped plugins can be found at
|
||||||
https://github.com/certbot/certbot/blob/master/tools/snap/generate_dnsplugins_snapcraft.sh.
|
https://github.com/certbot/certbot/blob/main/tools/snap/generate_dnsplugins_snapcraft.sh.
|
||||||
|
|
||||||
For more information on building externally snapped plugins, see the section on
|
For more information on building externally snapped plugins, see the section on
|
||||||
:ref:`Building snaps`.
|
:ref:`Building snaps`.
|
||||||
@@ -562,7 +562,7 @@ Building the Certbot and DNS plugin snaps
|
|||||||
|
|
||||||
Instructions for how to manually build and run the Certbot snap and the externally
|
Instructions for how to manually build and run the Certbot snap and the externally
|
||||||
snapped DNS plugins that the Certbot project supplies are located in the README
|
snapped DNS plugins that the Certbot project supplies are located in the README
|
||||||
file at https://github.com/certbot/certbot/tree/master/tools/snap.
|
file at https://github.com/certbot/certbot/tree/main/tools/snap.
|
||||||
|
|
||||||
Updating the documentation
|
Updating the documentation
|
||||||
==========================
|
==========================
|
||||||
|
|||||||
@@ -25,7 +25,7 @@ We release packages and upload them to PyPI (wheels and source tarballs).
|
|||||||
|
|
||||||
The following scripts are used in the process:
|
The following scripts are used in the process:
|
||||||
|
|
||||||
- https://github.com/certbot/certbot/blob/master/tools/release.sh
|
- https://github.com/certbot/certbot/blob/main/tools/release.sh
|
||||||
|
|
||||||
We use git tags to identify releases, using `Semantic Versioning`_. For
|
We use git tags to identify releases, using `Semantic Versioning`_. For
|
||||||
example: `v0.11.1`.
|
example: `v0.11.1`.
|
||||||
@@ -50,7 +50,7 @@ key servers.
|
|||||||
Notes for package maintainers
|
Notes for package maintainers
|
||||||
=============================
|
=============================
|
||||||
|
|
||||||
0. Please use our tagged releases, not ``master``!
|
0. Please use our tagged releases, not ``main``!
|
||||||
|
|
||||||
1. Do not package ``certbot-compatibility-test`` as it's only used internally.
|
1. Do not package ``certbot-compatibility-test`` as it's only used internally.
|
||||||
|
|
||||||
|
|||||||
@@ -99,7 +99,7 @@ Apache
|
|||||||
------
|
------
|
||||||
|
|
||||||
The Apache plugin currently `supports
|
The Apache plugin currently `supports
|
||||||
<https://github.com/certbot/certbot/blob/master/certbot-apache/certbot_apache/_internal/entrypoint.py>`_
|
<https://github.com/certbot/certbot/blob/main/certbot-apache/certbot_apache/_internal/entrypoint.py>`_
|
||||||
modern OSes based on Debian, Fedora, SUSE, Gentoo, CentOS and Darwin.
|
modern OSes based on Debian, Fedora, SUSE, Gentoo, CentOS and Darwin.
|
||||||
This automates both obtaining *and* installing certificates on an Apache
|
This automates both obtaining *and* installing certificates on an Apache
|
||||||
webserver. To specify this plugin on the command line, simply include
|
webserver. To specify this plugin on the command line, simply include
|
||||||
|
|||||||
@@ -66,9 +66,9 @@ parser.add_argument('--branch',
|
|||||||
parser.add_argument('--pull_request',
|
parser.add_argument('--pull_request',
|
||||||
default='~',
|
default='~',
|
||||||
help='certbot/certbot pull request to trial')
|
help='certbot/certbot pull request to trial')
|
||||||
parser.add_argument('--merge_master',
|
parser.add_argument('--merge_main',
|
||||||
action='store_true',
|
action='store_true',
|
||||||
help="if set merges PR into master branch of certbot/certbot")
|
help="if set merges PR into main branch of certbot/certbot")
|
||||||
parser.add_argument('--saveinstances',
|
parser.add_argument('--saveinstances',
|
||||||
action='store_true',
|
action='store_true',
|
||||||
help="don't kill EC2 instances after run, useful for debugging")
|
help="don't kill EC2 instances after run, useful for debugging")
|
||||||
@@ -207,7 +207,7 @@ def block_until_instance_ready(booting_instance, extra_wait_time=20):
|
|||||||
# Fabric Routines
|
# Fabric Routines
|
||||||
#-------------------------------------------------------------------------------
|
#-------------------------------------------------------------------------------
|
||||||
def local_git_clone(local_cxn, repo_url, log_dir):
|
def local_git_clone(local_cxn, repo_url, log_dir):
|
||||||
"""clones master of repo_url"""
|
"""clones main of repo_url"""
|
||||||
local_cxn.local('cd %s && if [ -d letsencrypt ]; then rm -rf letsencrypt; fi' % log_dir)
|
local_cxn.local('cd %s && if [ -d letsencrypt ]; then rm -rf letsencrypt; fi' % log_dir)
|
||||||
local_cxn.local('cd %s && git clone %s letsencrypt'% (log_dir, repo_url))
|
local_cxn.local('cd %s && git clone %s letsencrypt'% (log_dir, repo_url))
|
||||||
local_cxn.local('cd %s && tar czf le.tar.gz letsencrypt'% log_dir)
|
local_cxn.local('cd %s && tar czf le.tar.gz letsencrypt'% log_dir)
|
||||||
@@ -219,17 +219,17 @@ def local_git_branch(local_cxn, repo_url, branch_name, log_dir):
|
|||||||
(log_dir, repo_url, branch_name))
|
(log_dir, repo_url, branch_name))
|
||||||
local_cxn.local('cd %s && tar czf le.tar.gz letsencrypt' % log_dir)
|
local_cxn.local('cd %s && tar czf le.tar.gz letsencrypt' % log_dir)
|
||||||
|
|
||||||
def local_git_PR(local_cxn, repo_url, PRnumstr, log_dir, merge_master=True):
|
def local_git_PR(local_cxn, repo_url, PRnumstr, log_dir, merge_main=True):
|
||||||
"""clones specified pull request from repo_url and optionally merges into master"""
|
"""clones specified pull request from repo_url and optionally merges into main"""
|
||||||
local_cxn.local('cd %s && if [ -d letsencrypt ]; then rm -rf letsencrypt; fi' % log_dir)
|
local_cxn.local('cd %s && if [ -d letsencrypt ]; then rm -rf letsencrypt; fi' % log_dir)
|
||||||
local_cxn.local('cd %s && git clone %s letsencrypt' % (log_dir, repo_url))
|
local_cxn.local('cd %s && git clone %s letsencrypt' % (log_dir, repo_url))
|
||||||
local_cxn.local('cd %s && cd letsencrypt && '
|
local_cxn.local('cd %s && cd letsencrypt && '
|
||||||
'git fetch origin pull/%s/head:lePRtest' % (log_dir, PRnumstr))
|
'git fetch origin pull/%s/head:lePRtest' % (log_dir, PRnumstr))
|
||||||
local_cxn.local('cd %s && cd letsencrypt && git checkout lePRtest' % log_dir)
|
local_cxn.local('cd %s && cd letsencrypt && git checkout lePRtest' % log_dir)
|
||||||
if merge_master:
|
if merge_main:
|
||||||
local_cxn.local('cd %s && cd letsencrypt && git remote update origin' % log_dir)
|
local_cxn.local('cd %s && cd letsencrypt && git remote update origin' % log_dir)
|
||||||
local_cxn.local('cd %s && cd letsencrypt && '
|
local_cxn.local('cd %s && cd letsencrypt && '
|
||||||
'git merge origin/master -m "testmerge"' % log_dir)
|
'git merge origin/main -m "testmerge"' % log_dir)
|
||||||
local_cxn.local('cd %s && tar czf le.tar.gz letsencrypt' % log_dir)
|
local_cxn.local('cd %s && tar czf le.tar.gz letsencrypt' % log_dir)
|
||||||
|
|
||||||
def local_repo_to_remote(cxn, log_dir):
|
def local_repo_to_remote(cxn, log_dir):
|
||||||
@@ -382,9 +382,9 @@ def main():
|
|||||||
print("Making local git repo")
|
print("Making local git repo")
|
||||||
if cl_args.pull_request != '~':
|
if cl_args.pull_request != '~':
|
||||||
print('Testing PR %s ' % cl_args.pull_request,
|
print('Testing PR %s ' % cl_args.pull_request,
|
||||||
"MERGING into master" if cl_args.merge_master else "")
|
"MERGING into main" if cl_args.merge_main else "")
|
||||||
local_git_PR(local_cxn, cl_args.repo, cl_args.pull_request, log_dir,
|
local_git_PR(local_cxn, cl_args.repo, cl_args.pull_request, log_dir,
|
||||||
cl_args.merge_master)
|
cl_args.merge_main)
|
||||||
elif cl_args.branch != '~':
|
elif cl_args.branch != '~':
|
||||||
print('Testing branch %s of %s' % (cl_args.branch, cl_args.repo))
|
print('Testing branch %s of %s' % (cl_args.branch, cl_args.repo))
|
||||||
local_git_branch(local_cxn, cl_args.repo, cl_args.branch, log_dir)
|
local_git_branch(local_cxn, cl_args.repo, cl_args.branch, log_dir)
|
||||||
|
|||||||
@@ -1,4 +1,4 @@
|
|||||||
## nextversion - master
|
## nextversion - main
|
||||||
|
|
||||||
### Added
|
### Added
|
||||||
|
|
||||||
|
|||||||
+2
-2
@@ -97,7 +97,7 @@ fi
|
|||||||
git checkout "$RELEASE_BRANCH"
|
git checkout "$RELEASE_BRANCH"
|
||||||
|
|
||||||
# Update changelog
|
# Update changelog
|
||||||
sed -i "s/master/$(date +'%Y-%m-%d')/" certbot/CHANGELOG.md
|
sed -i "s/main/$(date +'%Y-%m-%d')/" certbot/CHANGELOG.md
|
||||||
git add certbot/CHANGELOG.md
|
git add certbot/CHANGELOG.md
|
||||||
git commit -m "Update changelog for $version release"
|
git commit -m "Update changelog for $version release"
|
||||||
|
|
||||||
@@ -205,7 +205,7 @@ git tag --local-user "$RELEASE_GPG_KEY" --sign --message "Release $version" "$ta
|
|||||||
git rm --cached -r "$built_package_dir"
|
git rm --cached -r "$built_package_dir"
|
||||||
git commit -m "Remove built packages from git"
|
git commit -m "Remove built packages from git"
|
||||||
|
|
||||||
# Add master section to CHANGELOG.md
|
# Add main section to CHANGELOG.md
|
||||||
header=$(head -n 4 certbot/CHANGELOG.md)
|
header=$(head -n 4 certbot/CHANGELOG.md)
|
||||||
body=$(sed s/nextversion/$nextversion/ tools/_changelog_top.txt)
|
body=$(sed s/nextversion/$nextversion/ tools/_changelog_top.txt)
|
||||||
footer=$(tail -n +5 certbot/CHANGELOG.md)
|
footer=$(tail -n +5 certbot/CHANGELOG.md)
|
||||||
|
|||||||
Reference in New Issue
Block a user