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
- Rewrite the few existing uses of `skaffold/(blob|tree)/HEAD` to use `main`
as GitHub's file viewer uses a commit rather than a branch.
- Rewrite the buildpacks references to use `main` since they already switched.
- Explicitly specify `main` for remote repositories due to GoogleContainerTools#6264
Copy file name to clipboardExpand all lines: CHANGELOG.md
+3-3
Original file line number
Diff line number
Diff line change
@@ -423,7 +423,7 @@ Note: This release comes with a new config version, `v2beta14`. To upgrade your
423
423
424
424
Highlights:
425
425
* More granular control of `port-forward` options. Checkout the updated [documentation](https://skaffold.dev/docs/pipeline-stages/port-forwarding/) for details.
426
-
*`InputDigest` image tagging strategy from the [Improve taggers proposal](https://github.com/GoogleContainerTools/skaffold/blob/master/docs/design_proposals/digest-tagger.md) has landed.
426
+
*`InputDigest` image tagging strategy from the [Improve taggers proposal](https://github.com/GoogleContainerTools/skaffold/blob/main/docs/design_proposals/digest-tagger.md) has landed.
* New command `skaffold apply` for when you want Skaffold to simply deploy your pre-rendered Kubernetes manifests.
507
507
* Debugging Python application using `skaffold debug` now uses `debugpy` by default.
508
508
* New tutorials for [`artifact dependencies`](https://skaffold.dev/docs/tutorials/artifact-dependencies/) and [`configuration dependencies`](https://skaffold.dev/docs/tutorials/config-dependencies/) features.
509
-
* New example project [`examples/custom-buildx`](https://github.com/GoogleContainerTools/skaffold/tree/master/examples/custom-buildx) showing how to build multi-arch images using Skaffold.
509
+
* New example project [`examples/custom-buildx`](https://github.com/GoogleContainerTools/skaffold/tree/main/examples/custom-buildx) showing how to build multi-arch images using Skaffold.
@@ -948,7 +948,7 @@ Note: This release comes with a new config version, `v2beta9`. To upgrade your s
948
948
Highlights:
949
949
* Artifact Modules Support: Skaffold allow users to specify artifact dependencies for dockerfile artifacts.
950
950
951
-
To use, look at [microservice example](https://github.com/GoogleContainerTools/skaffold/tree/master/examples/microservices). *Docs coming soon*
951
+
To use, look at [microservice example](https://github.com/GoogleContainerTools/skaffold/tree/main/examples/microservices). *Docs coming soon*
952
952
* Skaffold init support for polyglot-maven projects [#4871](https://github.com/GoogleContainerTools/skaffold/pull/4871)
953
953
* Skaffold `debug` helper images now moved to gcr.io/k8s-skaffold/skaffold-debug-support [#4961](https://github.com/GoogleContainerTools/skaffold/pull/4961)
Copy file name to clipboardExpand all lines: DEVELOPMENT.md
+4-4
Original file line number
Diff line number
Diff line change
@@ -69,7 +69,7 @@ Visual Studio Code with [Go plugin](https://github.com/Microsoft/vscode-go):
69
69
70
70
Some changes to the skaffold code require a change to the skaffold config. These changes require a few extra steps:
71
71
72
-
* Open the latest Config at [pkg/skaffold/schema/latest/v1/config.go](https://github.com/GoogleContainerTools/skaffold/blob/master/pkg/skaffold/schema/latest/v1/config.go) and inspect the comment at [L28](https://github.com/GoogleContainerTools/skaffold/blob/master/pkg/skaffold/schema/latest/v1/config.go#L28)
72
+
* Open the latest Config at [pkg/skaffold/schema/latest/v1/config.go](https://github.com/GoogleContainerTools/skaffold/blob/main/pkg/skaffold/schema/latest/v1/config.go) and inspect the comment at [L28](https://github.com/GoogleContainerTools/skaffold/blob/main/pkg/skaffold/schema/latest/v1/config.go#L28)
73
73
* If the line mentions the config version is not released, proceed making your changes.
74
74
```
75
75
// This config version is not yet released, it is SAFE TO MODIFY the structs in this file.
@@ -101,14 +101,14 @@ For more details behind the logic of config changes see [the Skaffold config man
101
101
102
102
## Making changes to the Skaffold API
103
103
104
-
We build the API directly through gRPC, which gets translated into REST API through a reverse proxy gateway library. When adding new message types, make changes to [proto/v1/skaffold.proto](https://github.com/GoogleContainerTools/skaffold/blob/master/proto/v1/skaffold.proto), and when adding new enum types, make changes to [proto/enums/enums.proto](https://github.com/GoogleContainerTools/skaffold/blob/master/proto/enums/enums.proto). When changing either of these files, you can run `./hack/generate-proto.sh` to generate the equivalent Go code.
104
+
We build the API directly through gRPC, which gets translated into REST API through a reverse proxy gateway library. When adding new message types, make changes to [proto/v1/skaffold.proto](https://github.com/GoogleContainerTools/skaffold/blob/main/proto/v1/skaffold.proto), and when adding new enum types, make changes to [proto/enums/enums.proto](https://github.com/GoogleContainerTools/skaffold/blob/main/proto/enums/enums.proto). When changing either of these files, you can run `./hack/generate-proto.sh` to generate the equivalent Go code.
105
105
106
106
## Adding actionable error messages to code.
107
107
Skaffold has a built-in framework to provide actionable error messages for user to help bootstrap skaffold errors.
108
108
109
109
Also, [v1.19.0](https://github.com/GoogleContainerTools/skaffold/releases/tag/v1.19.0) onwards, skaffold is collecting failure error codes to help the team get more insights into common failure scenarios.
110
110
111
-
To take advantage of this framework, contributors can simply use the [`ErrDef`](https://github.com/GoogleContainerTools/skaffold/blob/master/pkg/skaffold/errors/err_def.go#L32) struct to throw meaningful actionable error messages and
111
+
To take advantage of this framework, contributors can simply use the [`ErrDef`](https://github.com/GoogleContainerTools/skaffold/blob/main/pkg/skaffold/errors/err_def.go#L32) struct to throw meaningful actionable error messages and
112
112
improve user experience.
113
113
114
114
e.g In this example [PR](https://github.com/GoogleContainerTools/skaffold/pull/5953),
@@ -280,7 +280,7 @@ Skaffold release process works with Google Cloud Build within our own project `k
280
280
281
281
In order to be able to iterate/fix the release process you can pass in your own project and bucket as parameters to the build.
282
282
283
-
We continuously release **builds** under `gs://skaffold/builds`. This is done by triggering `cloudbuild.yaml` on every push to master.
283
+
We continuously release **builds** under `gs://skaffold/builds`. This is done by triggering `cloudbuild.yaml` on every push to `main`.
Copy file name to clipboardExpand all lines: codelab/02_kpt-deploy/tutorial.md
+3-3
Original file line number
Diff line number
Diff line change
@@ -15,7 +15,7 @@ Kpt is [an OSS tool](https://github.com/GoogleContainerTools/kpt) for Kubernetes
15
15
* How to enable kpt to deploy your configurations in their live state.
16
16
* How to use kpt with kustomize.
17
17
18
-
This codelab is the second session. Check out the [01_kpt-validate](https://github.com/GoogleContainerTools/skaffold/tree/master/codelab/01_kpt-validate) about how to use kpt to validate your configuration before deploying to the cluster.
18
+
This codelab is the second session. Check out the [01_kpt-validate](https://github.com/GoogleContainerTools/skaffold/tree/main/codelab/01_kpt-validate) about how to use kpt to validate your configuration before deploying to the cluster.
19
19
20
20
## Prerequisites
21
21
@@ -87,7 +87,7 @@ Time to complete: **About 3 minutes**
> If you haven't used `skaffold dev`, you can go through this [codelab](https://github.com/GoogleContainerTools/skaffold/tree/master/codelab/01_kpt-validate).
90
+
> If you haven't used `skaffold dev`, you can go through this [codelab](https://github.com/GoogleContainerTools/skaffold/tree/main/codelab/01_kpt-validate).
91
91
92
92
## Deploy
93
93
Time to complete: **About 2 minutes**
@@ -226,4 +226,4 @@ from the skaffold.yaml[ reference doc](https://skaffold.dev/docs/references/yaml
226
226
227
227
You can also try out other kpt features like `kpt pkg` and `kpt cfg` from
228
228
[the user guide](https://googlecontainertools.github.io/kpt/reference/). They will be supported
Copy file name to clipboardExpand all lines: docs/content/en/docs/design/api.md
+2-2
Original file line number
Diff line number
Diff line change
@@ -112,7 +112,7 @@ kick off a suite of Selenium tests against the newly deployed service.
112
112
113
113
{{% tabs %}}
114
114
{{% tab "HTTP API" %}}
115
-
Using `curl` and `HTTP_RPC_PORT=50052`, an example output of a `skaffold dev` execution on our [getting-started example](https://github.com/GoogleContainerTools/skaffold/tree/master/examples/getting-started)
115
+
Using `curl` and `HTTP_RPC_PORT=50052`, an example output of a `skaffold dev` execution on our [getting-started example](https://github.com/GoogleContainerTools/skaffold/tree/main/examples/getting-started)
@@ -176,7 +176,7 @@ The State API provides a snapshot of the current state of the following componen
176
176
**Examples**
177
177
{{% tabs %}}
178
178
{{% tab "HTTP API" %}}
179
-
Using `curl` and `HTTP_RPC_PORT=50052`, an example output of a `skaffold dev` execution on our [microservices example](https://github.com/GoogleContainerTools/skaffold/tree/master/examples/microservices)
179
+
Using `curl` and `HTTP_RPC_PORT=50052`, an example output of a `skaffold dev` execution on our [microservices example](https://github.com/GoogleContainerTools/skaffold/tree/main/examples/microservices)
The environment variable `SKAFFOLD_REMOTE_CACHE_DIR` or flag `--remote-cache-dir` specifies the download location for all remote repos. If undefined then it defaults to `~/.skaffold/repos`.
153
153
The repo root directory name is a hash of the repo `uri` and the `branch/ref`.
154
-
Every execution of a remote module resets the cached repo to the referenced ref. The default ref is master. If master is not defined then it defaults to main.
154
+
Every execution of a remote module resets the cached repo to the referenced ref. The default ref is `master`. If `master` is not defined then it defaults to `main`.
155
155
The remote config gets treated like a local config after substituting the path with the actual path in the cache directory.
156
156
157
157
### Profile Activation in required configs
@@ -179,4 +179,4 @@ Here, `profile1` is a profile that needs to exist in both configs `cfg1` and `cf
179
179
180
180
{{< alert title="Follow up" >}}
181
181
Take a look at the [tutorial]({{< relref "/docs/tutorials/config-dependencies" >}}) section to see this in action.
Copy file name to clipboardExpand all lines: docs/content/en/docs/pipeline-stages/filesync.md
+2-2
Original file line number
Diff line number
Diff line change
@@ -114,7 +114,7 @@ artifacts:
114
114
Skaffold requires special collaboration from buildpacks for the `auto` sync to work.
115
115
116
116
Cloud Native Buildpacks set a `io.buildpacks.build.metadata` label on the images they create.
117
-
This labels points to json description of the [Bill-of-Materials, aka BOM](https://github.com/buildpacks/spec/blob/master/buildpack.md#bill-of-materials-toml) of the build.
117
+
This labels points to json description of the [Bill-of-Materials, aka BOM](https://github.com/buildpacks/spec/blob/main/buildpack.md#bill-of-materials-toml) of the build.
118
118
In the BOM, under the `metadata.devmode.sync` key, Buildpacks that want to collaborate with Skaffold
119
119
have to output the sync rules based on their exploration of the source and the build process they had to apply to it.
120
120
Those sync rules will then be used by Skaffold without the user having to configure them manually.
@@ -127,7 +127,7 @@ signal to change the way the application is built so that it reloads the changes
127
127
128
128
Jib integration with Skaffold allows for zero-config `auto` sync. In this mode, Jib will sync your class files, resource files, and Jib's "extra directories" files to a remote container as changes are made. It can only be used with Jib in the default build mode (exploded) for non-WAR applications. It was primarily designed around [Spring Boot Developer Tools](https://docs.spring.io/spring-boot/docs/current/reference/html/using-spring-boot.html#using-boot-devtools), but can work with any embedded server that can reload/restart.
129
129
130
-
Check out the [Jib Sync example](https://github.com/GoogleContainerTools/skaffold/tree/master/examples/jib-sync) for more details.
130
+
Check out the [Jib Sync example](https://github.com/GoogleContainerTools/skaffold/tree/main/examples/jib-sync) for more details.
Copy file name to clipboardExpand all lines: docs/content/en/docs/pipeline-stages/init.md
+2-2
Original file line number
Diff line number
Diff line change
@@ -24,7 +24,7 @@ than 500MB.
24
24
If there are multiple build configuration files, Skaffold will prompt you to pair your build configuration files
25
25
with any images detected in your deploy configuration.
26
26
27
-
E.g. For an application with [two microservices](https://github.com/GoogleContainerTools/skaffold/tree/master/examples/microservices):
27
+
E.g. For an application with [two microservices](https://github.com/GoogleContainerTools/skaffold/tree/main/examples/microservices):
28
28
29
29
```bash
30
30
skaffold init
@@ -41,7 +41,7 @@ If this image is one you want Skaffold to build, you'll need to manually set up
41
41
`skaffold` init also recognizes Maven and Gradle projects, and will auto-suggest the [`jib`]({{<relref "/docs/pipeline-stages/builders#/local#jib-maven-and-gradle">}}) builder.
42
42
Currently `jib` artifact detection is disabled by default, but can be enabled using the flag `--XXenableJibInit`.
43
43
44
-
You can try this out on our example [jib project](https://github.com/GoogleContainerTools/skaffold/tree/master/examples/jib-multimodule)
44
+
You can try this out on our example [jib project](https://github.com/GoogleContainerTools/skaffold/tree/main/examples/jib-multimodule)
Copy file name to clipboardExpand all lines: docs/content/en/docs/pipeline-stages/log-tailing.md
+1-1
Original file line number
Diff line number
Diff line change
@@ -15,7 +15,7 @@ Log Tailing is **disabled by default** for `run` mode; it can be enabled with th
15
15
16
16
17
17
## Log Structure
18
-
To view log structure, run `skaffold run --tail` in [`examples/microservices`](https://github.com/GoogleContainerTools/skaffold/tree/master/examples/microservices)
18
+
To view log structure, run `skaffold run --tail` in [`examples/microservices`](https://github.com/GoogleContainerTools/skaffold/tree/main/examples/microservices)
Copy file name to clipboardExpand all lines: docs/content/en/docs/references/api/grpc.md
+1-1
Original file line number
Diff line number
Diff line change
@@ -23,7 +23,7 @@ We also generate the [reference doc for the HTTP layer]({{<relref "/docs/referen
23
23
24
24
## v1/skaffold.proto
25
25
26
-
You can find the source for v1/skaffold.proto [on Github](https://github.com/GoogleContainerTools/skaffold/blob/master/proto/v1/v1/skaffold.proto).
26
+
You can find the source for v1/skaffold.proto [on Github](https://github.com/GoogleContainerTools/skaffold/blob/main/proto/v1/v1/skaffold.proto).
Copy file name to clipboardExpand all lines: docs/content/en/docs/tutorials/artifact-dependencies.md
+2-2
Original file line number
Diff line number
Diff line change
@@ -13,7 +13,7 @@ To learn more about how to set up Skaffold and a Kubernetes cluster, see the [qu
13
13
14
14
## Tutorial - Simple artifact dependency
15
15
16
-
This tutorial will be based on the [simple-artifact-dependency](https://github.com/GoogleContainerTools/skaffold/tree/master/examples/simple-artifact-dependency) example in our repository.
16
+
This tutorial will be based on the [simple-artifact-dependency](https://github.com/GoogleContainerTools/skaffold/tree/main/examples/simple-artifact-dependency) example in our repository.
17
17
18
18
19
19
## Adding an artifact dependency
@@ -30,7 +30,7 @@ The image alias `BASE` is now available as a build-arg in the Dockerfile for `ap
30
30
31
31
## Build and Deploy
32
32
33
-
In the [simple-artifact-dependency](https://github.com/GoogleContainerTools/skaffold/tree/master/examples/simple-artifact-dependency) directory, run:
33
+
In the [simple-artifact-dependency](https://github.com/GoogleContainerTools/skaffold/tree/main/examples/simple-artifact-dependency) directory, run:
0 commit comments