Skip to content

Commit 831f72f

Browse files
committed
Align docs
Signed-off-by: Timo Sand <timo.sand@f-secure.com>
1 parent f68a7b3 commit 831f72f

2 files changed

Lines changed: 16 additions & 14 deletions

File tree

ARCHITECTURE.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -594,8 +594,8 @@ The following features are blocked waiting for upstream changes in [google/go-gi
594594
| `escapeIDPart(part)` | Escape colons in ID parts |
595595
| `wrapErrors([]error)` | Convert errors to diagnostics |
596596
| `checkOrganization(meta)` | Verify org context |
597-
| `getTeamID(idOrSlug, meta)` | Resolve team ID from ID or slug |
598-
| `getTeamSlug(idOrSlug, meta)` | Resolve team slug from ID or slug |
597+
| `getTeamID(ctx, meta, idOrSlug)` | Resolve team ID from ID or slug |
598+
| `getTeamSlug(ctx, meta, idOrSlug)` | Resolve team slug from ID or slug |
599599
| `expandStringList([]any)` | Convert to `[]string` |
600600
| `flattenStringList([]string)` | Convert to `[]any` |
601601
| `deleteResourceOn404AndSwallow304OtherwiseReturnError(...)` | Handle 404/304 responses |

CONTRIBUTING.md

Lines changed: 14 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -102,7 +102,7 @@ Setting a `processId` of 0 allows a dropdown to select the process of the provid
102102

103103
## Manual Testing
104104

105-
Manual testing should be performed on each PR opened in order to validate the provider's correct behavior and discover any regressions. Our automated testing is in an unhealthy spot at this point unfortunately, so extra care is required with manual testing. See [issue #1414](https://github.com/integrations/terraform-provider-github/issues/1414) for more details.
105+
> **Note:** Automated test coverage is incomplete ([#1414](https://github.com/integrations/terraform-provider-github/issues/1414)). Manual testing on each PR is essential until this is resolved.
106106
107107
### Using a local version of the provider
108108

@@ -142,7 +142,19 @@ The following provider development overrides are set in the CLI configuration:
142142
- integrations/github in /Users/jcudit/go/bin
143143
```
144144

145-
### Environment variable reference
145+
See the [Environment Variable Reference](#environment-variable-reference) below for the full list of configuration options.
146+
147+
There are also a small amount of unit tests in the provider. Due to the nature of the provider, such tests are currently only recommended for exercising functionality completely internal to the provider. These may be executed by running `make test`.
148+
149+
### GitHub Organization
150+
151+
If you do not have an organization already that you are comfortable running tests against, you will need to [create one](https://help.github.com/en/articles/creating-a-new-organization-from-scratch). The free "Team for Open Source" org type is fine for these tests. The name of the organization must then be exported in your environment as `GITHUB_OWNER`.
152+
153+
Make sure that your organization has a `terraform-template-module` repository ([terraformtesting/terraform-template-module](https://github.com/terraformtesting/terraform-template-module) is an example you can clone) and that its "Template repository" item in Settings is checked.
154+
155+
If you are interested in using and/or testing GitHub's [Team synchronization](https://help.github.com/en/github/setting-up-and-managing-organizations-and-teams/synchronizing-teams-between-your-identity-provider-and-github) feature, please contact a maintainer as special arrangements can be made for your convenience.
156+
157+
## Environment Variable Reference
146158

147159
Commonly required environment variables are listed below:
148160

@@ -190,16 +202,6 @@ export GH_TEST_ADVANCED_SECURITY=
190202
export GH_TEST_ENTERPRISE_IS_EMU=
191203
```
192204

193-
There are also a small amount of unit tests in the provider. Due to the nature of the provider, such tests are currently only recommended for exercising functionality completely internal to the provider. These may be executed by running `make test`.
194-
195-
### GitHub Organization
196-
197-
If you do not have an organization already that you are comfortable running tests against, you will need to [create one](https://help.github.com/en/articles/creating-a-new-organization-from-scratch). The free "Team for Open Source" org type is fine for these tests. The name of the organization must then be exported in your environment as `GITHUB_OWNER`.
198-
199-
Make sure that your organization has a `terraform-template-module` repository ([terraformtesting/terraform-template-module](https://github.com/terraformtesting/terraform-template-module) is an example you can clone) and that its "Template repository" item in Settings is checked.
200-
201-
If you are interested in using and/or testing GitHub's [Team synchronization](https://help.github.com/en/github/setting-up-and-managing-organizations-and-teams/synchronizing-teams-between-your-identity-provider-and-github) feature, please contact a maintainer as special arrangements can be made for your convenience.
202-
203205
### Example _.vscode/settings.json_ file
204206

205207
To run acceptance tests the `TF_ACC` environment variable must be set. Below is an example `settings.json` file for VSCode that sets this variable and the other necessary environment variables when running tests from the editor.

0 commit comments

Comments
 (0)