mirror/stackexchange-dnscontrol
1
0
Fork 0
mirror of https://github.com/StackExchange/dnscontrol.git synced 2024-05-11 05:55:12 +00:00
Code Issues Releases Activity

DOCS: Rename build filenames (#2681)

Browse Source
This commit is contained in:
Jeffrey Cafferata
2023-12-05 14:46:51 +01:00
committed by GitHub
parent cbccbbeb8d
commit 3ed24a9af6
3 changed files with 8 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
documentation/byo-secrets.md
View File

@@ -62,16 +62,16 @@ Step 1: Create a branch
Create a branch as you normally would to submit a PR to the project.
Step 2: Update `build.yml`
Step 2: Update `pr_test.yml`
In this branch, edit `.github/workflows/build.yml`:
In this branch, edit `.github/workflows/pr_test.yml`:
1. In the `integration-test-providers` section, the name of the provider.
Add your provider's name (alphabetically).
The line looks something like:
{% code title=".github/workflows/build.yml" %}
{% code title=".github/workflows/pr_test.yml" %}
```
PROVIDERS: "['BIND','HEXONET','AZURE_DNS','CLOUDFLAREAPI','GCLOUD','NAMEDOTCOM','ROUTE53','CLOUDNS','DIGITALOCEAN','GANDI_V5','HEDNS','INWX','NS1','POWERDNS','TRANSIP']"
```
@@ -83,7 +83,7 @@ Add it to the `env` section of `integrtests-diff2`.
For example, the entry for BIND looks like:
{% code title=".github/workflows/build.yml" %}
{% code title=".github/workflows/pr_test.yml" %}
```
BIND_DOMAIN: ${{ vars.BIND_DOMAIN }}
```
@@ -95,7 +95,7 @@ If there are other env variables (for example, for an API key), add that as a "s
For example, the entry for CLOUDFLAREAPI looks like this:
{% code title=".github/workflows/build.yml" %}
{% code title=".github/workflows/pr_test.yml" %}
```
CLOUDFLAREAPI_ACCOUNTID: ${{ secrets.CLOUDFLAREAPI_ACCOUNTID }}
CLOUDFLAREAPI_TOKEN: ${{ secrets.CLOUDFLAREAPI_TOKEN }}

4
documentation/release-engineering.md
View File

@@ -130,7 +130,7 @@ find * -name \*.bak -delete
GHA is configured to run an integration test for any provider listed in the "provider" list. However the test is skipped if the `*_DOMAIN` variable is not set. For example, the Google Cloud provider integration test is only run if `GCLOUD_DOMAIN` is set.
* Q: Where is the list of providers to run integration tests on?
* A: In `.github/workflows/build.yml`: (1) the "PROVIDERS" list, (2) the `integrtests-diff2` section.
* A: In `.github/workflows/pr_test.yml`: (1) the "PROVIDERS" list, (2) the `integrtests-diff2` section.
* Q: Where are non-secret environment variables stored?
* A: GHA calls them "Variables". Update them here: https://github.com/StackExchange/dnscontrol/settings/variables/actions
@@ -140,7 +140,7 @@ GHA is configured to run an integration test for any provider listed in the "pro
### How do I add a single new integration test?
1. Edit `.github/workflows/build.yml`
1. Edit `.github/workflows/pr_test.yml`
2. Add the `FOO_DOMAIN` variable name of the provider to the "PROVIDERS" list.
3. Set the `FOO_DOMAIN` variables in GHA via https://github.com/StackExchange/dnscontrol/settings/variables/actions
4. All other variables should be stored as secrets (for consistency). Add them to the `integrtests-diff2` section.