Skip to content

Commit a32a2c9

Browse files
authored
docs: Add build tag information (#1664)
Description of changes: Add note about `Unresolved Type X` errors caused by missing build tags. Discussion (Slack): https://kubernetes.slack.com/archives/C0402D8JJS1/p1675605921217409 By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.
1 parent 6a16d23 commit a32a2c9

File tree

1 file changed

+9
-0
lines changed
  • docs/content/docs/contributor-docs

1 file changed

+9
-0
lines changed

docs/content/docs/contributor-docs/setup.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -73,6 +73,15 @@ Make sure in your `$GOPATH/src` that you have directories for the
7373
mkdir -p $GOPATH/src/github.com/aws-controllers-k8s
7474
```
7575

76+
{{% hint type="info" title="Contributing to ACK core repositories" %}}
77+
If you plan to make changes to one of the ACK core repositories e.g.,
78+
`code-generator `, you might see errors in your IDE, such as `Unresolved Type
79+
"Operation"`. This is because some packages, like
80+
`github.com/aws/aws-sdk-go/private/model/api` use Go build tags which some IDEs
81+
do not enable by default. For Goland, build tag documentation can be found
82+
[here](https://www.jetbrains.com/help/go/configuring-build-constraints-and-vendoring.html#configure-build-constraints-for-your-project).
83+
{{% /hint %}}
84+
7685
## `git clone` forked repositories and add upstream remote
7786

7887
For each of your forked repositories, you will `git clone` the repository into

0 commit comments

Comments
 (0)