You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
6. Configure Python 2.7+ with [pyenv][pyenv] if your default is Python 3.x.
58
59
7. Install make.
59
60
8. Install [timeout][timeout]
60
-
-`brew install coreutils` on MacOS.
61
+
-`brew install coreutils` on macOS.
61
62
62
63
### Get the source
63
64
@@ -96,14 +97,16 @@ To pin a new dependency:
96
97
- Run `go get <repository>@<version>`.
97
98
- (Optional) Add a `replace` statement in `go.mod`.
98
99
99
-
A few Makefile and scripts are offered to work with go modules:
100
+
Makefile targets and scripts are offered to work with go modules:
100
101
101
-
-`hack/ensure-go.sh` file checks that the Go version and environment variables are properly set.
102
+
-`make verify-modules` checks whether go module files are out of date.
103
+
-`make modules` runs `go mod tidy` to ensure proper vendoring.
104
+
-`hack/ensure-go.sh` checks that the Go version and environment variables are properly set.
102
105
103
106
### Setting up the environment
104
107
105
108
Your environment must have the Azure credentials as outlined in the [getting
106
-
started prerequisites section](./getting-started.md#Prerequisites)
109
+
started prerequisites](./getting-started.md#Prerequisites) section.
107
110
108
111
### Using Tilt
109
112
@@ -150,20 +153,20 @@ make kind-reset
150
153
151
154
If you want to develop in both CAPI and CAPZ at the same time, then this is the path for you.
152
155
153
-
To use [Tilt](https://tilt.dev/) for a simplified development workflow, follow the [instructions](https://cluster-api.sigs.k8s.io/developer/tilt.html) in the cluster-api repo. The instructions will walk you through cloning the Cluster API (capi) repository and configuring Tilt to use `kind` to deploy the cluster api management components.
156
+
To use [Tilt](https://tilt.dev/) for a simplified development workflow, follow the [instructions](https://cluster-api.sigs.k8s.io/developer/tilt.html) in the cluster-api repo. The instructions will walk you through cloning the Cluster API (CAPI) repository and configuring Tilt to use `kind` to deploy the cluster api management components.
154
157
155
-
> you may wish to checkout out the correct version of capi to match the [version used in capz](go.mod)
158
+
> you may wish to checkout out the correct version of CAPI to match the [version used in CAPZ](go.mod)
156
159
157
160
Note that `tilt up` will be run from the `cluster-api repository` directory and the `tilt-settings.json` file will point back to the `cluster-api-provider-azure` repository directory. Any changes you make to the source code in `cluster-api` or `cluster-api-provider-azure` repositories will automatically redeployed to the `kind` cluster.
158
161
159
-
After you have cloned both repositories your folder structure should look like:
162
+
After you have cloned both repositories, your folder structure should look like:
160
163
161
164
```tree
162
165
|-- src/cluster-api-provider-azure
163
166
|-- src/cluster-api (run `tilt up` here)
164
167
```
165
168
166
-
After configuring the environment variables, you can run the following to generate you`tilt-settings.json` file:
169
+
After configuring the environment variables, run the following to generate your`tilt-settings.json` file:
0 commit comments