Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore: include dependencies in release notes #315

Merged
merged 1 commit into from
Oct 28, 2024

Conversation

willmurphyscode
Copy link
Contributor

Otherwise, there are often empty stereoscope release notes.

Manual testing

With these changes, running GITHUB_TOKEN=$(gh auth token) make changelog in stereoscope today produces the following release notes (without these changes release notes were empty):

# v0.0.5

### Dependency Updates

- bump github.com/sylabs/sif/v2 from 2.19.1 to 2.19.2 in the go group [[#313](https://github.com/anchore/stereoscope/pull/313) @dependabot]
- bump github.com/adrg/xdg from 0.5.0 to 0.5.1 in the go group [[#310](https://github.com/anchore/stereoscope/pull/310) @dependabot]

**[(Full Changelog)](https://github.com/anchore/stereoscope/compare/v0.0.4...v0.0.5)**

Otherwise, there are often empty stereoscope release notes.

Signed-off-by: Will Murphy <[email protected]>
@willmurphyscode willmurphyscode enabled auto-merge (squash) October 28, 2024 19:14
Copy link

Benchmark Test Results

Benchmark results from the latest changes vs base branch
make .tool/task
make[1]: Entering directory '/home/runner/work/stereoscope/stereoscope'
make[1]: Leaving directory '/home/runner/work/stereoscope/stereoscope'
.tool/task show-benchstat
?   	github.com/anchore/stereoscope	[no test files]
?   	github.com/anchore/stereoscope/examples	[no test files]
PASS
ok  	github.com/anchore/stereoscope/internal	0.004s
?   	github.com/anchore/stereoscope/internal/bus	[no test files]
PASS
ok  	github.com/anchore/stereoscope/internal/containerd	0.007s
PASS
ok  	github.com/anchore/stereoscope/internal/docker	0.005s
?   	github.com/anchore/stereoscope/internal/log	[no test files]
PASS
ok  	github.com/anchore/stereoscope/internal/podman	0.005s
?   	github.com/anchore/stereoscope/pkg/event	[no test files]
?   	github.com/anchore/stereoscope/pkg/event/parsers	[no test files]
goos: linux
goarch: amd64
pkg: github.com/anchore/stereoscope/pkg/file
cpu: AMD EPYC 7763 64-Core Processor                
BenchmarkTarIndex-4   	   33289	     35943 ns/op	    5699 B/op	      93 allocs/op
BenchmarkTarIndex-4   	   33277	     35947 ns/op	    5701 B/op	      93 allocs/op
BenchmarkTarIndex-4   	   33105	     36522 ns/op	    5700 B/op	      93 allocs/op
BenchmarkTarIndex-4   	   33163	     35992 ns/op	    5701 B/op	      93 allocs/op
BenchmarkTarIndex-4   	   33170	     36094 ns/op	    5699 B/op	      93 allocs/op
BenchmarkTarIndex-4   	   33003	     36775 ns/op	    5699 B/op	      93 allocs/op
BenchmarkTarIndex-4   	   33109	     36076 ns/op	    5701 B/op	      93 allocs/op
PASS
ok  	github.com/anchore/stereoscope/pkg/file	10.979s
PASS
ok  	github.com/anchore/stereoscope/pkg/filetree	0.005s
?   	github.com/anchore/stereoscope/pkg/filetree/filenode	[no test files]
PASS
ok  	github.com/anchore/stereoscope/pkg/image	0.005s
PASS
ok  	github.com/anchore/stereoscope/pkg/image/containerd	0.008s
PASS
ok  	github.com/anchore/stereoscope/pkg/image/docker	0.005s
PASS
ok  	github.com/anchore/stereoscope/pkg/image/oci	0.005s
PASS
ok  	github.com/anchore/stereoscope/pkg/image/oci/credhelpers	0.005s
?   	github.com/anchore/stereoscope/pkg/image/podman	[no test files]
PASS
ok  	github.com/anchore/stereoscope/pkg/image/sif	0.004s
?   	github.com/anchore/stereoscope/pkg/imagetest	[no test files]
PASS
ok  	github.com/anchore/stereoscope/pkg/tree	0.003s
PASS
ok  	github.com/anchore/stereoscope/pkg/tree/node	0.004s
goos: linux
goarch: amd64
pkg: github.com/anchore/stereoscope/test/integration
cpu: AMD EPYC 7763 64-Core Processor                
BenchmarkSimpleImage_GetImage/docker-archive-4 	    1092	   1101894 ns/op	  273564 B/op	    2287 allocs/op
BenchmarkSimpleImage_GetImage/docker-archive-4 	    1088	   1097289 ns/op	  273010 B/op	    2286 allocs/op
BenchmarkSimpleImage_GetImage/docker-archive-4 	    1089	   1096944 ns/op	  272866 B/op	    2285 allocs/op
BenchmarkSimpleImage_GetImage/docker-archive-4 	    1093	   1088966 ns/op	  272692 B/op	    2285 allocs/op
BenchmarkSimpleImage_GetImage/docker-archive-4 	    1088	   1119664 ns/op	  272834 B/op	    2285 allocs/op
BenchmarkSimpleImage_GetImage/docker-archive-4 	    1100	   1234848 ns/op	  272455 B/op	    2285 allocs/op
BenchmarkSimpleImage_GetImage/docker-archive-4 	    1070	   1152222 ns/op	  272381 B/op	    2285 allocs/op
BenchmarkSimpleImage_GetImage/podman-4         	      66	  18148053 ns/op	  401517 B/op	    2700 allocs/op
BenchmarkSimpleImage_GetImage/podman-4         	      58	  17911886 ns/op	  401678 B/op	    2699 allocs/op
BenchmarkSimpleImage_GetImage/podman-4         	      69	  18377154 ns/op	  402283 B/op	    2701 allocs/op
BenchmarkSimpleImage_GetImage/podman-4         	      66	  19383495 ns/op	  401679 B/op	    2700 allocs/op
BenchmarkSimpleImage_GetImage/podman-4         	      62	  18303995 ns/op	  401468 B/op	    2699 allocs/op
BenchmarkSimpleImage_GetImage/podman-4         	      67	  18269417 ns/op	  401091 B/op	    2699 allocs/op
BenchmarkSimpleImage_GetImage/podman-4         	      67	  18458077 ns/op	  402224 B/op	    2701 allocs/op
#0 building with "default" instance using docker driver

#1 [internal] load build definition from Dockerfile
#1 transferring dockerfile: 345B done
#1 DONE 0.0s

#2 [internal] load .dockerignore
#2 transferring context: 2B done
#2 DONE 0.0s

#3 [internal] load build context
#3 transferring context: 209B done
#3 DONE 0.0s

#4 [1/3] ADD file-1.txt /somefile-1.txt
#4 CACHED

#5 [2/3] ADD file-2.txt /somefile-2.txt
#5 CACHED

#6 [3/3] ADD target /
#6 CACHED

#7 exporting to image
#7 exporting layers done
#7 writing image sha256:5c89662ba69b0c67af14f52d70c94975e2157f33302da541c2ef131ae44f433f done
#7 naming to docker.io/library/stereoscope-fixture-image-simple:04e16e44161c8888a1a963720fd0443cbf7eef8101434c431de8725cd98cc9f7 done
#7 naming to docker.io/library/stereoscope-fixture-image-simple:latest done
#7 DONE 0.0s
ctr: failed to dial "/run/containerd/containerd.sock": connection error: desc = "transport: error while dialing: dial unix /run/containerd/containerd.sock: connect: permission denied"
--- FAIL: BenchmarkSimpleImage_GetImage
    image_fixtures.go:193: using existing image tar: 'test-fixtures/cache/stereoscope-fixture-image-simple-04e16e44161c8888a1a963720fd0443cbf7eef8101434c431de8725cd98cc9f7.tar' (size: 22528, modified: 2024-10-28 19:13:14.063308162 +0000 UTC, mode: -rw-r--r--)
    image_fixtures.go:241: Build docker image: name="stereoscope-fixture-image-simple" tag="04e16e44161c8888a1a963720fd0443cbf7eef8101434c431de8725cd98cc9f7"
    image_fixtures.go:291: saveImage running: docker image save stereoscope-fixture-image-simple:04e16e44161c8888a1a963720fd0443cbf7eef8101434c431de8725cd98cc9f7
    image_fixtures.go:286: 
        	Error Trace:	/home/runner/work/stereoscope/stereoscope/pkg/imagetest/image_fixtures.go:286
        	            				/home/runner/work/stereoscope/stereoscope/pkg/imagetest/image_fixtures.go:162
        	            				/home/runner/work/stereoscope/stereoscope/pkg/imagetest/image_fixtures.go:152
        	            				/home/runner/work/stereoscope/stereoscope/pkg/imagetest/image_fixtures.go:33
        	            				/home/runner/work/stereoscope/stereoscope/test/integration/fixture_image_simple_test.go:163
        	Error:      	Received unexpected error:
        	            	exit status 1
        	Test:       	BenchmarkSimpleImage_GetImage
        	Messages:   	could not import docker image to containerd (shell out)
BenchmarkSimpleImage_FetchSquashedContents/docker-archive-4         	   53750	     22302 ns/op	    2712 B/op	      21 allocs/op
BenchmarkSimpleImage_FetchSquashedContents/docker-archive-4         	   53947	     22238 ns/op	    2712 B/op	      21 allocs/op
BenchmarkSimpleImage_FetchSquashedContents/docker-archive-4         	   53416	     22264 ns/op	    2712 B/op	      21 allocs/op
BenchmarkSimpleImage_FetchSquashedContents/docker-archive-4         	   53487	     22271 ns/op	    2712 B/op	      21 allocs/op
BenchmarkSimpleImage_FetchSquashedContents/docker-archive-4         	   53644	     22262 ns/op	    2712 B/op	      21 allocs/op
BenchmarkSimpleImage_FetchSquashedContents/docker-archive-4         	   53520	     22282 ns/op	    2712 B/op	      21 allocs/op
BenchmarkSimpleImage_FetchSquashedContents/docker-archive-4         	   53335	     22222 ns/op	    2712 B/op	      21 allocs/op
BenchmarkSimpleImage_FetchSquashedContents/podman-4                 	   53515	     22254 ns/op	    2712 B/op	      21 allocs/op
BenchmarkSimpleImage_FetchSquashedContents/podman-4                 	   54055	     22150 ns/op	    2712 B/op	      21 allocs/op
BenchmarkSimpleImage_FetchSquashedContents/podman-4                 	   53175	     22360 ns/op	    2712 B/op	      21 allocs/op
BenchmarkSimpleImage_FetchSquashedContents/podman-4                 	   53907	     22220 ns/op	    2712 B/op	      21 allocs/op
BenchmarkSimpleImage_FetchSquashedContents/podman-4                 	   54066	     22243 ns/op	    2712 B/op	      21 allocs/op
BenchmarkSimpleImage_FetchSquashedContents/podman-4                 	   53509	     22405 ns/op	    2712 B/op	      21 allocs/op
BenchmarkSimpleImage_FetchSquashedContents/podman-4                 	   53836	     22215 ns/op	    2712 B/op	      21 allocs/op
#0 building with "default" instance using docker driver

#1 [internal] load build definition from Dockerfile
#1 transferring dockerfile: 345B done
#1 DONE 0.0s

#2 [internal] load .dockerignore
#2 transferring context: 2B done
#2 DONE 0.0s

#3 [internal] load build context
#3 transferring context: 209B done
#3 DONE 0.0s

#4 [1/3] ADD file-1.txt /somefile-1.txt
#4 CACHED

#5 [2/3] ADD file-2.txt /somefile-2.txt
#5 CACHED

#6 [3/3] ADD target /
#6 CACHED

#7 exporting to image
#7 exporting layers done
#7 writing image sha256:5c89662ba69b0c67af14f52d70c94975e2157f33302da541c2ef131ae44f433f done
#7 naming to docker.io/library/stereoscope-fixture-image-simple:04e16e44161c8888a1a963720fd0443cbf7eef8101434c431de8725cd98cc9f7 done
#7 naming to docker.io/library/stereoscope-fixture-image-simple:latest done
#7 DONE 0.0s
ctr: failed to dial "/run/containerd/containerd.sock": connection error: desc = "transport: error while dialing: dial unix /run/containerd/containerd.sock: connect: permission denied"
--- FAIL: BenchmarkSimpleImage_FetchSquashedContents
    image_fixtures.go:193: using existing image tar: 'test-fixtures/cache/stereoscope-fixture-image-simple-04e16e44161c8888a1a963720fd0443cbf7eef8101434c431de8725cd98cc9f7.tar' (size: 22528, modified: 2024-10-28 19:13:14.063308162 +0000 UTC, mode: -rw-r--r--)
    image_fixtures.go:241: Build docker image: name="stereoscope-fixture-image-simple" tag="04e16e44161c8888a1a963720fd0443cbf7eef8101434c431de8725cd98cc9f7"
    image_fixtures.go:291: saveImage running: docker image save stereoscope-fixture-image-simple:04e16e44161c8888a1a963720fd0443cbf7eef8101434c431de8725cd98cc9f7
    image_fixtures.go:286: 
        	Error Trace:	/home/runner/work/stereoscope/stereoscope/pkg/imagetest/image_fixtures.go:286
        	            				/home/runner/work/stereoscope/stereoscope/pkg/imagetest/image_fixtures.go:162
        	            				/home/runner/work/stereoscope/stereoscope/pkg/imagetest/image_fixtures.go:152
        	            				/home/runner/work/stereoscope/stereoscope/pkg/imagetest/image_fixtures.go:33
        	            				/home/runner/work/stereoscope/stereoscope/pkg/imagetest/image_fixtures.go:64
        	            				/home/runner/work/stereoscope/stereoscope/test/integration/fixture_image_simple_test.go:189
        	Error:      	Received unexpected error:
        	            	exit status 1
        	Test:       	BenchmarkSimpleImage_FetchSquashedContents
        	Messages:   	could not import docker image to containerd (shell out)
FAIL
exit status 1
FAIL	github.com/anchore/stereoscope/test/integration	39.411s
?   	github.com/anchore/stereoscope/test/integration/test-fixtures/registry	[no test files]
FAIL
goos: linux
goarch: amd64
pkg: github.com/anchore/stereoscope/pkg/file
cpu: AMD EPYC 7763 64-Core Processor                
ctr: 
           │ .tmp/benchmark-36d2171-dirty.txt │
           │              sec/op              │
TarIndex-4                        36.08µ ± 2%

           │ .tmp/benchmark-36d2171-dirty.txt │
           │               B/op               │
TarIndex-4                       5.566Ki ± 0%

           │ .tmp/benchmark-36d2171-dirty.txt │
           │            allocs/op             │
TarIndex-4                         93.00 ± 0%

pkg: github.com/anchore/stereoscope/test/integration
                                      │ .tmp/benchmark-36d2171-dirty.txt │
                                      │              sec/op              │
SimpleImage_GetImage/docker-archive-4                       1.102m ± 12%
SimpleImage_GetImage/podman-4                               18.30m ±  6%
geomean                                                     4.491m

                                      │ .tmp/benchmark-36d2171-dirty.txt │
                                      │               B/op               │
SimpleImage_GetImage/docker-archive-4                       266.4Ki ± 0%
SimpleImage_GetImage/podman-4                               392.3Ki ± 0%
geomean                                                     323.3Ki

                                      │ .tmp/benchmark-36d2171-dirty.txt │
                                      │            allocs/op             │
SimpleImage_GetImage/docker-archive-4                        2.285k ± 0%
SimpleImage_GetImage/podman-4                                2.700k ± 0%
geomean                                                      2.484k

ctr: failed to dial "/run/containerd/containerd.sock": connection error: desc = "transport: error while dialing: dial unix /run/containerd/containerd.sock: connect: permission denied"
                                                   │ .tmp/benchmark-36d2171-dirty.txt │
                                                   │              sec/op              │
SimpleImage_FetchSquashedContents/docker-archive-4                        22.26µ ± 0%
SimpleImage_FetchSquashedContents/podman-4                                22.24µ ± 1%
geomean                                                                   22.25µ

                                                   │ .tmp/benchmark-36d2171-dirty.txt │
                                                   │               B/op               │
SimpleImage_FetchSquashedContents/docker-archive-4                       2.648Ki ± 0%
SimpleImage_FetchSquashedContents/podman-4                               2.648Ki ± 0%
geomean                                                                  2.648Ki

                                                   │ .tmp/benchmark-36d2171-dirty.txt │
                                                   │            allocs/op             │
SimpleImage_FetchSquashedContents/docker-archive-4                         21.00 ± 0%
SimpleImage_FetchSquashedContents/podman-4                                 21.00 ± 0%
geomean                                                                    21.00
goos: linux
goarch: amd64
pkg: github.com/anchore/stereoscope/pkg/file
cpu: AMD EPYC 7763 64-Core Processor                
ctr: 
           │ .tmp/benchmark-36d2171-dirty.txt │
           │              sec/op              │
TarIndex-4                        36.08µ ± 2%

           │ .tmp/benchmark-36d2171-dirty.txt │
           │               B/op               │
TarIndex-4                       5.566Ki ± 0%

           │ .tmp/benchmark-36d2171-dirty.txt │
           │            allocs/op             │
TarIndex-4                         93.00 ± 0%

pkg: github.com/anchore/stereoscope/test/integration
                                      │ .tmp/benchmark-36d2171-dirty.txt │
                                      │              sec/op              │
SimpleImage_GetImage/docker-archive-4                       1.102m ± 12%
SimpleImage_GetImage/podman-4                               18.30m ±  6%
geomean                                                     4.491m

                                      │ .tmp/benchmark-36d2171-dirty.txt │
                                      │               B/op               │
SimpleImage_GetImage/docker-archive-4                       266.4Ki ± 0%
SimpleImage_GetImage/podman-4                               392.3Ki ± 0%
geomean                                                     323.3Ki

                                      │ .tmp/benchmark-36d2171-dirty.txt │
                                      │            allocs/op             │
SimpleImage_GetImage/docker-archive-4                        2.285k ± 0%
SimpleImage_GetImage/podman-4                                2.700k ± 0%
geomean                                                      2.484k

ctr: failed to dial "/run/containerd/containerd.sock": connection error: desc = "transport: error while dialing: dial unix /run/containerd/containerd.sock: connect: permission denied"
                                                   │ .tmp/benchmark-36d2171-dirty.txt │
                                                   │              sec/op              │
SimpleImage_FetchSquashedContents/docker-archive-4                        22.26µ ± 0%
SimpleImage_FetchSquashedContents/podman-4                                22.24µ ± 1%
geomean                                                                   22.25µ

                                                   │ .tmp/benchmark-36d2171-dirty.txt │
                                                   │               B/op               │
SimpleImage_FetchSquashedContents/docker-archive-4                       2.648Ki ± 0%
SimpleImage_FetchSquashedContents/podman-4                               2.648Ki ± 0%
geomean                                                                  2.648Ki

                                                   │ .tmp/benchmark-36d2171-dirty.txt │
                                                   │            allocs/op             │
SimpleImage_FetchSquashedContents/docker-archive-4                         21.00 ± 0%
SimpleImage_FetchSquashedContents/podman-4                                 21.00 ± 0%
geomean                                                                    21.00

@willmurphyscode willmurphyscode merged commit bcc40c6 into main Oct 28, 2024
7 checks passed
@willmurphyscode willmurphyscode deleted the chore-depsin-release-notes branch October 28, 2024 19:18
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants