Skip to content
This repository was archived by the owner on Sep 4, 2025. It is now read-only.
/ yaml-diff Public archive

Make a diff between 2 yaml files.

License

Notifications You must be signed in to change notification settings

sters/yaml-diff

Repository files navigation

yaml-diff

go codecov go-report

Deprecated

I'm no longer maintein this repo. Instead, I'm creating an another tool which is more generic version of yaml-diff. Please see this repo.

https://github.com/sters/diffnest


Usage

go install github.com/sters/yaml-diff/cmd/yaml-diff@latest

or download from Releases.

yaml-diff path/to/foo.yaml path/to/bar.yaml

If the given yaml has a --- separated structure, then the two yaml's will get all the differences in their respective structures. The one with the smallest difference is considered to be the same structure and the difference is displayed.

The result structure is the same as based or target yaml but format (includes map fields order) is different.

Example

You can try example directory.
$ go run cmd/yaml-diff/main.go example/a.yaml example/b.yaml
--- example/a.yaml
+++ example/b.yaml

  apiVersion: "v1"
  kind: "Service"
  metadata:
    name: "my-service"
  spec:
    selector:
      app: "MyApp"
    ports:
      -
        protocol: "TCP"
-       port: 80
+       port: 8080
        targetPort: 9376

  apiVersion: "apps/v1"
  kind: "Deployment"
  metadata:
    name: "app-deployment"
    labels:
      app: "MyApp"
  spec:
-   replicas: 3
+   replicas: 10
    selector:
      matchLabels:
        app: "MyApp"
    template:
      metadata:
        labels:
          app: "MyApp"
      spec:
        containers:
          -
            name: "app"
-           image: "my-app:1.0.0"
+           image: "my-app:1.1.0"
            ports:
              -
                containerPort: 9376

- foo: "missing-in-b"

  this:
    is:
      the: "same"
-     empty:

+ bar:
+   - "missing in a.yaml"

+ baz:
+   - "missing in a.yaml"
$ go run cmd/yaml-diff/main.go --ignore-empty-fields example/a.yaml example/b.yaml
--- example/a.yaml
+++ example/b.yaml

  apiVersion: "v1"
  kind: "Service"
  metadata:
    name: "my-service"
  spec:
    selector:
      app: "MyApp"
    ports:
      -
        protocol: "TCP"
-       port: 80
+       port: 8080
        targetPort: 9376

  apiVersion: "apps/v1"
  kind: "Deployment"
  metadata:
    name: "app-deployment"
    labels:
      app: "MyApp"
  spec:
-   replicas: 3
+   replicas: 10
    selector:
      matchLabels:
        app: "MyApp"
    template:
      metadata:
        labels:
          app: "MyApp"
      spec:
        containers:
          -
            name: "app"
-           image: "my-app:1.0.0"
+           image: "my-app:1.1.0"
            ports:
              -
                containerPort: 9376

- foo: "missing-in-b"

  this:
    is:
      the: "same"
      empty:

+ bar:
+   - "missing in a.yaml"

+ baz:
+   - "missing in a.yaml"

About

Make a diff between 2 yaml files.

Topics

Resources

License

Stars

Watchers

Forks

Sponsor this project

 

Contributors 3

  •  
  •  
  •