From 355c0fe6a1edb2c04fe56f2fc482bb6f90fabebc Mon Sep 17 00:00:00 2001 From: Jeffrey Cafferata Date: Wed, 10 Jan 2024 21:50:12 +0100 Subject: [PATCH] CICD: Rename the master branch to main (#2774) Co-authored-by: Tom Limoncelli --- .editorconfig | 2 +- .github/workflows/codeql.yml | 4 ++-- .github/workflows/pr_test.yml | 4 ++-- documentation/creds-json.md | 2 +- documentation/getting-started.md | 4 ++-- documentation/notifications.md | 2 +- documentation/release-engineering.md | 6 +++--- documentation/styleguide-doc.md | 14 +++++++------- documentation/writing-providers.md | 4 ++-- providers/desec/protocol.go | 2 +- 10 files changed, 22 insertions(+), 22 deletions(-) diff --git a/.editorconfig b/.editorconfig index 3deaa8a71..6fa964d7e 100644 --- a/.editorconfig +++ b/.editorconfig @@ -114,7 +114,7 @@ indent_size = 2 indent_style = space # Svelte -# https://github.com/sveltejs/svelte/blob/master/.editorconfig +# https://github.com/sveltejs/svelte/blob/main/.editorconfig [*.svelte] indent_size = 2 indent_style = tab diff --git a/.github/workflows/codeql.yml b/.github/workflows/codeql.yml index 289478b91..dc724f155 100644 --- a/.github/workflows/codeql.yml +++ b/.github/workflows/codeql.yml @@ -13,10 +13,10 @@ name: "CodeQL" on: push: - branches: [ "master" ] + branches: [ "main" ] pull_request: # The branches below must be a subset of the branches above - branches: [ "master" ] + branches: [ "main" ] schedule: - cron: '32 19 * * 0' diff --git a/.github/workflows/pr_test.yml b/.github/workflows/pr_test.yml index 226111f31..7af78c99f 100644 --- a/.github/workflows/pr_test.yml +++ b/.github/workflows/pr_test.yml @@ -1,7 +1,7 @@ name: "PR: Run all tests" on: - # git push origin master:tlim_testpr --force - # will trigger a full PR test on the master branch: + # git push origin main:tlim_testpr --force + # will trigger a full PR test on the main branch: # https://github.com/StackExchange/dnscontrol/actions/workflows/pr_test.yml?query=branch%3Atlim_testpr push: branches: diff --git a/documentation/creds-json.md b/documentation/creds-json.md index 19f6e6ef7..8b57e1c00 100644 --- a/documentation/creds-json.md +++ b/documentation/creds-json.md @@ -205,7 +205,7 @@ This example requires the [1Password command-line tool](https://developer.1passw but works with any shell command that returns a properly formatted `creds.json`. In this case, the 1Password CLI is used to inject the secrets from a 1Password vault, rather than storing them in environment variables. -An example of a template file containing Linode and Cloudflare API credentials is available here: [creds.json](https://github.com/StackExchange/dnscontrol/blob/master/documentation/assets/1password/creds.json). +An example of a template file containing Linode and Cloudflare API credentials is available here: [creds.json](https://github.com/StackExchange/dnscontrol/blob/main/documentation/assets/1password/creds.json). {% code title="creds.json" %} ```json diff --git a/documentation/getting-started.md b/documentation/getting-started.md index 357e5826d..49df0f5b2 100644 --- a/documentation/getting-started.md +++ b/documentation/getting-started.md @@ -89,7 +89,7 @@ use BIND for DNS service, it is useful for testing. domains, and so on. Start your `dnsconfig.js` file by downloading -[dnsconfig.js](https://github.com/StackExchange/dnscontrol/blob/master/documentation/assets/getting-started/dnsconfig.js) +[dnsconfig.js](https://github.com/StackExchange/dnscontrol/blob/main/documentation/assets/getting-started/dnsconfig.js) and renaming it. The file looks like: @@ -155,7 +155,7 @@ It is only needed if any providers require credentials (API keys, usernames, passwords, etc.). Start your `creds.json` file by downloading -[creds.json](https://github.com/StackExchange/dnscontrol/blob/master/documentation/assets/getting-started/creds.json) +[creds.json](https://github.com/StackExchange/dnscontrol/blob/main/documentation/assets/getting-started/creds.json) and renaming it. The file looks like: diff --git a/documentation/notifications.md b/documentation/notifications.md index 081e1dc3a..efd274369 100644 --- a/documentation/notifications.md +++ b/documentation/notifications.md @@ -2,7 +2,7 @@ DNSControl has build in support for notifications when changes are made. This allows you to post messages in team chat, or send emails when dns changes are made. -Notifications are written in the [notifications package](https://github.com/StackExchange/dnscontrol/tree/master/pkg/notifications), and is a really simple interface to implement if you want to add +Notifications are written in the [notifications package](https://github.com/StackExchange/dnscontrol/tree/main/pkg/notifications), and is a really simple interface to implement if you want to add new types or destinations. ## Configuration diff --git a/documentation/release-engineering.md b/documentation/release-engineering.md index 8f1302fc6..dd0cb8173 100644 --- a/documentation/release-engineering.md +++ b/documentation/release-engineering.md @@ -11,7 +11,7 @@ Please change the version number as appropriate. Substitute (for example) ```shell export VERSION=v4.2.0 -git checkout master +git checkout main git pull go fmt ./... go generate ./... @@ -19,7 +19,7 @@ go mod tidy git commit -a -m "Update generated files for $VERSION" ``` -## Step 2. Tag the commit in master that you want to release +## Step 2. Tag the commit in main that you want to release ```shell export VERSION=v4.2.0 @@ -152,7 +152,7 @@ Overview: You will fork the repo and add any secrets to your fork. For security 1. [Fork StackExchange/dnscontrol](https://github.com/StackExchange/dnscontrol/fork) in GitHub. - If you already have a fork, be sure to use the "sync fork" button on the main page to sync with master. + If you already have a fork, be sure to use the "sync fork" button on the main page to sync with the upstream. 2. In your fork, set the `${DOMAIN}_DOMAIN` variable in GHA via Settings :: Secrets and variables :: Actions :: Variables. diff --git a/documentation/styleguide-doc.md b/documentation/styleguide-doc.md index a8c620ff0..523b39c67 100644 --- a/documentation/styleguide-doc.md +++ b/documentation/styleguide-doc.md @@ -2,18 +2,18 @@ ## Where are the docs? -TL;DR version: [`docs`](https://github.com/StackExchange/dnscontrol/tree/master/docs) is the [marketing website](https://dnscontrol.org). [`documentation`](https://github.com/StackExchange/dnscontrol/tree/master/documentation) is the [docs.dnscontrol.org](https://docs.dnscontrol.org/) website. (Yes, the names are backwards!) +TL;DR version: [`docs`](https://github.com/StackExchange/dnscontrol/tree/main/docs) is the [marketing website](https://dnscontrol.org). [`documentation`](https://github.com/StackExchange/dnscontrol/tree/main/documentation) is the [docs.dnscontrol.org](https://docs.dnscontrol.org/) website. (Yes, the names are backwards!) **The two websites** 1. * The main website - * Source code: [`docs`](https://github.com/StackExchange/dnscontrol/tree/master/docs) + * Source code: [`docs`](https://github.com/StackExchange/dnscontrol/tree/main/docs) * Mostly "marketing" for the project. * Rarely changes. Updated via GitHub "pages" feature. 2. * Project documentation - * Source code: [`documentation`](https://github.com/StackExchange/dnscontrol/tree/master/documentation) + * Source code: [`documentation`](https://github.com/StackExchange/dnscontrol/tree/main/documentation) * Users and developer documentation * Changes frequently. Updated via [GitBook](https://www.gitbook.com/) @@ -21,10 +21,10 @@ TL;DR version: [`docs`](https://github.com/StackExchange/dnscontrol/tree/master/ Within the git repo, docs are grouped: -* [`documentation/`](https://github.com/StackExchange/dnscontrol/tree/master/documentation): general docs -* [`documentation/providers/`](https://github.com/StackExchange/dnscontrol/tree/master/documentation/providers/): One file per provider -* [`documentation/functions/`](https://github.com/StackExchange/dnscontrol/tree/master/documentation/functions/): One file per `dnsconfig.js` language feature -* [`documentation/assets/FOO/`](https://github.com/StackExchange/dnscontrol/tree/master/documentation/assets/): Images for page FOO(PNGs only, please!) +* [`documentation/`](https://github.com/StackExchange/dnscontrol/tree/main/documentation): general docs +* [`documentation/providers/`](https://github.com/StackExchange/dnscontrol/tree/main/documentation/providers/): One file per provider +* [`documentation/functions/`](https://github.com/StackExchange/dnscontrol/tree/main/documentation/functions/): One file per `dnsconfig.js` language feature +* [`documentation/assets/FOO/`](https://github.com/StackExchange/dnscontrol/tree/main/documentation/assets/): Images for page FOO(PNGs only, please!) ## How to add a new page? diff --git a/documentation/writing-providers.md b/documentation/writing-providers.md index a4cd00a8b..42f1b5831 100644 --- a/documentation/writing-providers.md +++ b/documentation/writing-providers.md @@ -122,7 +122,7 @@ Directory names should be consitent. It should be all lowercase and match the A ## Step 4: Activate the driver Edit -[providers/\_all/all.go](https://github.com/StackExchange/dnscontrol/blob/master/providers/_all/all.go). +[providers/\_all/all.go](https://github.com/StackExchange/dnscontrol/blob/main/providers/_all/all.go). Add the provider list so DNSControl knows it exists. ## Step 5: Implement @@ -163,7 +163,7 @@ Integration tests use a test account and a test domain. All records will be deleted from the test domain! Use a OTE domain or a real domain that isn't otherwise in use and can be destroyed. {% endhint %} -* Edit [integrationTest/providers.json](https://github.com/StackExchange/dnscontrol/blob/master/integrationTest/providers.json): +* Edit [integrationTest/providers.json](https://github.com/StackExchange/dnscontrol/blob/main/integrationTest/providers.json): * Add the `creds.json` info required for this provider in the form of environment variables. Now you can run the integration tests. diff --git a/providers/desec/protocol.go b/providers/desec/protocol.go index c7c1c4aa2..f056352b5 100644 --- a/providers/desec/protocol.go +++ b/providers/desec/protocol.go @@ -144,7 +144,7 @@ func (c *desecProvider) buildIndexFromResponse(bodyString []byte) error { return nil } -// Parses the Link Header into a map (https://github.com/desec-io/desec-tools/blob/master/fetch_zone.py#L13) +// Parses the Link Header into a map (https://github.com/desec-io/desec-tools/blob/main/fetch_zone.py#L13) func (c *desecProvider) convertLinks(links string) map[string]string { mapping := make(map[string]string) printer.Debugf("Header: %s\n", links)