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.

Sign up for GitHub

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

Jump to bottom

Add release docs #305

Merged
merged 1 commit into from
Oct 10, 2024
Merged

Add release docs #305

merged 1 commit into from
Oct 10, 2024

Conversation

wagoodman
Copy link
Contributor

Adds release expectations and procedures

@wagoodman
add release docs
0ab72e7 
Signed-off-by: Alex Goodman <[email protected]>
@wagoodman wagoodman added documentation Improvements or additions to documentation release relating to the release process of stereoscope labels Oct 10, 2024
@github-actions GitHub Actions
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   	   33001	     36224 ns/op	    5701 B/op	      93 allocs/op
BenchmarkTarIndex-4   	   32752	     36206 ns/op	    5700 B/op	      93 allocs/op
BenchmarkTarIndex-4   	   33163	     36141 ns/op	    5703 B/op	      93 allocs/op
BenchmarkTarIndex-4   	   33062	     36170 ns/op	    5700 B/op	      93 allocs/op
BenchmarkTarIndex-4   	   33046	     36068 ns/op	    5699 B/op	      93 allocs/op
BenchmarkTarIndex-4   	   33195	     37300 ns/op	    5702 B/op	      93 allocs/op
BenchmarkTarIndex-4   	   32666	     36399 ns/op	    5701 B/op	      93 allocs/op
PASS
ok  	github.com/anchore/stereoscope/pkg/file	10.988s
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.006s
PASS
ok  	github.com/anchore/stereoscope/pkg/image/containerd	0.008s
PASS
ok  	github.com/anchore/stereoscope/pkg/image/docker	0.006s
PASS
ok  	github.com/anchore/stereoscope/pkg/image/oci	0.006s
PASS
ok  	github.com/anchore/stereoscope/pkg/image/oci/credhelpers	0.006s
?   	github.com/anchore/stereoscope/pkg/image/podman	[no test files]
PASS
ok  	github.com/anchore/stereoscope/pkg/image/sif	0.005s
?   	github.com/anchore/stereoscope/pkg/imagetest	[no test files]
PASS
ok  	github.com/anchore/stereoscope/pkg/tree	0.004s
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 	    1054	   1117658 ns/op	  281172 B/op	    2222 allocs/op
BenchmarkSimpleImage_GetImage/docker-archive-4 	    1059	   1112291 ns/op	  280711 B/op	    2221 allocs/op
BenchmarkSimpleImage_GetImage/docker-archive-4 	    1083	   1114595 ns/op	  280799 B/op	    2221 allocs/op
BenchmarkSimpleImage_GetImage/docker-archive-4 	    1080	   1124724 ns/op	  280671 B/op	    2221 allocs/op
BenchmarkSimpleImage_GetImage/docker-archive-4 	    1083	   1097809 ns/op	  280516 B/op	    2221 allocs/op
BenchmarkSimpleImage_GetImage/docker-archive-4 	    1092	   1259702 ns/op	  280550 B/op	    2221 allocs/op
BenchmarkSimpleImage_GetImage/docker-archive-4 	    1076	   1111739 ns/op	  280289 B/op	    2221 allocs/op
BenchmarkSimpleImage_GetImage/podman-4         	      60	  19404806 ns/op	  410397 B/op	    2687 allocs/op
BenchmarkSimpleImage_GetImage/podman-4         	      66	  18937732 ns/op	  410188 B/op	    2686 allocs/op
BenchmarkSimpleImage_GetImage/podman-4         	      61	  19013589 ns/op	  409800 B/op	    2686 allocs/op
BenchmarkSimpleImage_GetImage/podman-4         	      67	  18960854 ns/op	  413288 B/op	    2687 allocs/op
BenchmarkSimpleImage_GetImage/podman-4         	      61	  19016723 ns/op	  409851 B/op	    2687 allocs/op
BenchmarkSimpleImage_GetImage/podman-4         	      61	  18705594 ns/op	  409369 B/op	    2686 allocs/op
BenchmarkSimpleImage_GetImage/podman-4         	      64	  19367235 ns/op	  409842 B/op	    2686 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:85dbff85c0721d67234bb7c67c397f6534026dd6f6061f73c55ee92a16be6220 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-10 15:13:31.061032856 +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         	   53629	     22469 ns/op	    2712 B/op	      21 allocs/op
BenchmarkSimpleImage_FetchSquashedContents/docker-archive-4         	   52992	     22423 ns/op	    2712 B/op	      21 allocs/op
BenchmarkSimpleImage_FetchSquashedContents/docker-archive-4         	   53058	     22530 ns/op	    2712 B/op	      21 allocs/op
BenchmarkSimpleImage_FetchSquashedContents/docker-archive-4         	   52938	     22774 ns/op	    2712 B/op	      21 allocs/op
BenchmarkSimpleImage_FetchSquashedContents/docker-archive-4         	   53635	     22526 ns/op	    2712 B/op	      21 allocs/op
BenchmarkSimpleImage_FetchSquashedContents/docker-archive-4         	   53317	     22480 ns/op	    2712 B/op	      21 allocs/op
BenchmarkSimpleImage_FetchSquashedContents/docker-archive-4         	   52281	     22513 ns/op	    2712 B/op	      21 allocs/op
BenchmarkSimpleImage_FetchSquashedContents/podman-4                 	   53073	     22484 ns/op	    2712 B/op	      21 allocs/op
BenchmarkSimpleImage_FetchSquashedContents/podman-4                 	   52819	     22575 ns/op	    2712 B/op	      21 allocs/op
BenchmarkSimpleImage_FetchSquashedContents/podman-4                 	   52941	     22631 ns/op	    2712 B/op	      21 allocs/op
BenchmarkSimpleImage_FetchSquashedContents/podman-4                 	   53048	     22482 ns/op	    2712 B/op	      21 allocs/op
BenchmarkSimpleImage_FetchSquashedContents/podman-4                 	   53146	     22542 ns/op	    2712 B/op	      21 allocs/op
BenchmarkSimpleImage_FetchSquashedContents/podman-4                 	   53263	     22486 ns/op	    2712 B/op	      21 allocs/op
BenchmarkSimpleImage_FetchSquashedContents/podman-4                 	   49688	     22507 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:85dbff85c0721d67234bb7c67c397f6534026dd6f6061f73c55ee92a16be6220 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-10 15:13:31.061032856 +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	40.282s
?   	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-60bc88c.txt │
           │           sec/op           │
TarIndex-4                  36.21µ ± 3%

           │ .tmp/benchmark-60bc88c.txt │
           │            B/op            │
TarIndex-4                 5.567Ki ± 0%

           │ .tmp/benchmark-60bc88c.txt │
           │         allocs/op          │
TarIndex-4                   93.00 ± 0%

pkg: github.com/anchore/stereoscope/test/integration
                                      │ .tmp/benchmark-60bc88c.txt │
                                      │           sec/op           │
SimpleImage_GetImage/docker-archive-4                 1.115m ± 13%
SimpleImage_GetImage/podman-4                         19.01m ±  2%
geomean                                               4.604m

                                      │ .tmp/benchmark-60bc88c.txt │
                                      │            B/op            │
SimpleImage_GetImage/docker-archive-4                 274.1Ki ± 0%
SimpleImage_GetImage/podman-4                         400.2Ki ± 1%
geomean                                               331.2Ki

                                      │ .tmp/benchmark-60bc88c.txt │
                                      │         allocs/op          │
SimpleImage_GetImage/docker-archive-4                  2.221k ± 0%
SimpleImage_GetImage/podman-4                          2.686k ± 0%
geomean                                                2.442k

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-60bc88c.txt │
                                                   │           sec/op           │
SimpleImage_FetchSquashedContents/docker-archive-4                  22.51µ ± 1%
SimpleImage_FetchSquashedContents/podman-4                          22.51µ ± 1%
geomean                                                             22.51µ

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

                                                   │ .tmp/benchmark-60bc88c.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-60bc88c.txt │
           │           sec/op           │
TarIndex-4                  36.21µ ± 3%

           │ .tmp/benchmark-60bc88c.txt │
           │            B/op            │
TarIndex-4                 5.567Ki ± 0%

           │ .tmp/benchmark-60bc88c.txt │
           │         allocs/op          │
TarIndex-4                   93.00 ± 0%

pkg: github.com/anchore/stereoscope/test/integration
                                      │ .tmp/benchmark-60bc88c.txt │
                                      │           sec/op           │
SimpleImage_GetImage/docker-archive-4                 1.115m ± 13%
SimpleImage_GetImage/podman-4                         19.01m ±  2%
geomean                                               4.604m

                                      │ .tmp/benchmark-60bc88c.txt │
                                      │            B/op            │
SimpleImage_GetImage/docker-archive-4                 274.1Ki ± 0%
SimpleImage_GetImage/podman-4                         400.2Ki ± 1%
geomean                                               331.2Ki

                                      │ .tmp/benchmark-60bc88c.txt │
                                      │         allocs/op          │
SimpleImage_GetImage/docker-archive-4                  2.221k ± 0%
SimpleImage_GetImage/podman-4                          2.686k ± 0%
geomean                                                2.442k

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-60bc88c.txt │
                                                   │           sec/op           │
SimpleImage_FetchSquashedContents/docker-archive-4                  22.51µ ± 1%
SimpleImage_FetchSquashedContents/podman-4                          22.51µ ± 1%
geomean                                                             22.51µ

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

                                                   │ .tmp/benchmark-60bc88c.txt │
                                                   │         allocs/op          │
SimpleImage_FetchSquashedContents/docker-archive-4                   21.00 ± 0%
SimpleImage_FetchSquashedContents/podman-4                           21.00 ± 0%
geomean                                                              21.00

@spiffcs spiffcs merged commit b06e144 into main Oct 10, 2024
7 checks passed
@spiffcs spiffcs deleted the add-release-docs branch October 10, 2024 17:47
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@spiffcs spiffcs spiffcs approved these changes

Assignees
No one assigned
Labels
documentation Improvements or additions to documentation release relating to the release process of stereoscope
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@wagoodman @spiffcs