Add attach command #433

qweeah · 2022-07-04T09:13:05Z

Introducing a new simplified experience to add an artifact to an existed manifest:

a new command attach to add an artifact to a existed manifest
refactor packing code
refactor status tracking

Related to #424

internal/content/file.go

cmd/oras/internal/input/file_unix.go

cmd/oras/internal/input/file_windows.go

Bumps [github.com/docker/cli](https://github.com/docker/cli) from 20.10.16+incompatible to 20.10.17+incompatible. - [Release notes](https://github.com/docker/cli/releases) - [Commits](docker/cli@v20.10.16...v20.10.17) --- updated-dependencies: - dependency-name: github.com/docker/cli dependency-type: direct:production update-type: version-update:semver-patch ... Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> Signed-off-by: Billy Zha <jinzha1@microsoft.com>

Signed-off-by: Billy Zha <qweeah@gmail.com> Signed-off-by: Billy Zha <jinzha1@microsoft.com>

Signed-off-by: Shiwei Zhang <shizh@microsoft.com> Signed-off-by: Billy Zha <jinzha1@microsoft.com>

Signed-off-by: Billy Zha <jinzha1@microsoft.com>

Signed-off-by: Shiwei Zhang <shizh@microsoft.com> Signed-off-by: Billy Zha <jinzha1@microsoft.com>

Signed-off-by: Billy Zha <qweeah@gmail.com> Signed-off-by: Billy Zha <jinzha1@microsoft.com>

…ras-project#425) Signed-off-by: Billy Zha <jinzha1@microsoft.com>

Signed-off-by: Billy Zha <jinzha1@microsoft.com>

Signed-off-by: Juncheng Zhu <junczhu@microsoft.com> Signed-off-by: Billy Zha <jinzha1@microsoft.com>

Signed-off-by: Billy Zha <jinzha1@microsoft.com>

Wwwsylvia · 2022-07-08T07:17:12Z

internal/content/file.go

+	}
+}
+
+// LoadFiles loads file reference to a file store and and returns the


nit: file references?

internal/content/file.go

Wwwsylvia · 2022-07-08T07:38:51Z

cmd/oras/internal/option/pusher.go

+
+// Pusher option struct.
+type Pusher struct {
+	ManifestExport string


maybe ManifestExportPath?

Wwwsylvia · 2022-07-08T07:40:23Z

cmd/oras/internal/option/pusher.go

+
+// ApplyFlags applies flags to a command flag set.
+func (opts *Pusher) ApplyFlags(fs *pflag.FlagSet) {
+	fs.StringVarP(&opts.ManifestExport, "export-manifest", "", "", "export the pushed manifest")


This sounds like a true/false flag. I think we need to call out this is the file path of the exported manifest.

Wwwsylvia · 2022-07-08T07:54:52Z

cmd/oras/internal/option/pusher.go

+}
+
+// ExportManifest saves the pushed manifest to a local file.
+func (opts *Pusher) ExportManifest(ctx context.Context, pushed ocispec.Descriptor, pushedTo content.Fetcher) error {


Should we have some unit tests for this function?

Will create an issue to add unit test for pusher options

cmd/oras/internal/display/status.go

cmd/oras/push.go

Wwwsylvia · 2022-07-08T08:15:28Z

cmd/oras/attach.go

+}
+
+// OCIToArtifact converts OCI descriptor to artifact descriptor.
+func OCIToArtifact(desc ocispec.Descriptor) *artifactspec.Descriptor {


Can we just return a struct?

Since & is banned for function return values, code will be cleaner if we returns a pointer

cmd/oras/attach.go

Signed-off-by: Billy Zha <jinzha1@microsoft.com>

shizhMSFT

LGTM

qweeah marked this pull request as draft July 4, 2022 09:13

qweeah changed the title ~~Add attach command~~ [WIP] Add attach command Jul 4, 2022

qweeah force-pushed the attach branch from c3d5b2d to 2765446 Compare July 7, 2022 02:33

qweeah changed the title ~~[WIP] Add attach command~~ Add attach command Jul 7, 2022

qweeah marked this pull request as ready for review July 7, 2022 03:29

shizhMSFT reviewed Jul 7, 2022

View reviewed changes

internal/content/file.go Outdated Show resolved Hide resolved

cmd/oras/internal/input/file_unix.go Outdated Show resolved Hide resolved

cmd/oras/internal/input/file_unix.go Outdated Show resolved Hide resolved

cmd/oras/internal/input/file_windows.go Outdated Show resolved Hide resolved

dependabot bot and others added 24 commits July 7, 2022 21:40

Add manifest config support (oras-project#412)

355231e

Signed-off-by: Billy Zha <qweeah@gmail.com> Signed-off-by: Billy Zha <jinzha1@microsoft.com>

Add CodeQL Security Scanning (oras-project#405)

6fae1ec

Signed-off-by: Shiwei Zhang <shizh@microsoft.com> Signed-off-by: Billy Zha <jinzha1@microsoft.com>

Update oras-go to alpha (oras-project#417)

2021f28

Signed-off-by: Billy Zha <jinzha1@microsoft.com>

Add Shiwei's key (oras-project#418)

832ae1e

Signed-off-by: Shiwei Zhang <shizh@microsoft.com> Signed-off-by: Billy Zha <jinzha1@microsoft.com>

Prepare for v0.13.0 (oras-project#420)

05313ea

Signed-off-by: Billy Zha <qweeah@gmail.com> Signed-off-by: Billy Zha <jinzha1@microsoft.com>

Update makefile (oras-project#423)

9641533

Signed-off-by: Billy Zha <qweeah@gmail.com> Signed-off-by: Billy Zha <jinzha1@microsoft.com>

Merging artifacts Branch: Add exporting manifest option for push (o…

b1f3cf3

…ras-project#425) Signed-off-by: Billy Zha <jinzha1@microsoft.com>

Update ghcr package action yaml (oras-project#422)

681d064

Signed-off-by: Billy Zha <jinzha1@microsoft.com>

Add digest-only and relocate manifest export

4cf8378

Signed-off-by: Billy Zha <jinzha1@microsoft.com>

Temporary code

6c09552

Signed-off-by: Billy Zha <jinzha1@microsoft.com>

Allow empty

568d9ec

Signed-off-by: Billy Zha <jinzha1@microsoft.com>

Refactor local file references

71c3d82

Signed-off-by: Billy Zha <jinzha1@microsoft.com>

Add windos parsing

4c87310

Signed-off-by: Billy Zha <jinzha1@microsoft.com>

Merging artifacts Branch: Add discover comand (oras-project#419)

1207844

Signed-off-by: Billy Zha <jinzha1@microsoft.com>

Merging artifacts Branch: Add discover comand (oras-project#419)

59c5756

Signed-off-by: Billy Zha <jinzha1@microsoft.com>

Add attach command

1c0ac49

Signed-off-by: Billy Zha <jinzha1@microsoft.com>

Add file reference type

ec0d45c

Signed-off-by: Billy Zha <jinzha1@microsoft.com>

Code clean

0ad95aa

Signed-off-by: Billy Zha <jinzha1@microsoft.com>

Fix breaking change

fc48c79

Signed-off-by: Billy Zha <jinzha1@microsoft.com>

fix: update help msg description about pullCmd() (oras-project#438)

89e8a89

Signed-off-by: Juncheng Zhu <junczhu@microsoft.com> Signed-off-by: Billy Zha <jinzha1@microsoft.com>

Temporary code

66469bc

Signed-off-by: Billy Zha <jinzha1@microsoft.com>

Allow empty

5d54197

Signed-off-by: Billy Zha <jinzha1@microsoft.com>

Refactor local file references

b9009ae

Signed-off-by: Billy Zha <jinzha1@microsoft.com>

Wwwsylvia suggested changes Jul 8, 2022

View reviewed changes

qweeah added 25 commits July 8, 2022 17:05

Add status tracking

9533f32

Signed-off-by: Billy Zha <jinzha1@microsoft.com>

Merge remote-tracking branch 'origin_src/main' into attach

06fe60c

Signed-off-by: Billy Zha <jinzha1@microsoft.com>

Add pre copy for pulling

ff87095

Signed-off-by: Billy Zha <jinzha1@microsoft.com>

Nit

2f037d0

Signed-off-by: Billy Zha <jinzha1@microsoft.com>

Remove nil map check

447a65d

Signed-off-by: Billy Zha <jinzha1@microsoft.com>

Resolve comments

36c2db9

Signed-off-by: Billy Zha <jinzha1@microsoft.com>

Reword

1904a0c

Signed-off-by: Billy Zha <jinzha1@microsoft.com>

Remove unused variable

c3c73db

Signed-off-by: Billy Zha <jinzha1@microsoft.com>

Merge remote-tracking branch 'origin_src/main' into attach

911e885

Rename status tracking function name

d0ad0c6

Signed-off-by: Billy Zha <jinzha1@microsoft.com>

Reword

d6f3044

Signed-off-by: Billy Zha <jinzha1@microsoft.com>

Rename

d84449c

Signed-off-by: Billy Zha <jinzha1@microsoft.com>

Rename file reference parsing

c92f22a

Signed-off-by: Billy Zha <jinzha1@microsoft.com>

Remove unnecessary goos tag

a1e2a3c

Signed-off-by: Billy Zha <jinzha1@microsoft.com>

Refactor loadFiles

b4e3642

Signed-off-by: Billy Zha <jinzha1@microsoft.com>

Remove unused lines

efd8ab7

Signed-off-by: Billy Zha <jinzha1@microsoft.com>

Reword

a6b4eef

Signed-off-by: Billy Zha <jinzha1@microsoft.com>

Make reference mandatory

6c53c31

Signed-off-by: Billy Zha <jinzha1@microsoft.com>

Add annotation and path validation skip to attach

c2099b2

Signed-off-by: Billy Zha <jinzha1@microsoft.com>

Remove empty lines

559e89c

Signed-off-by: Billy Zha <jinzha1@microsoft.com>

Remove empty lines

5f5d35f

Signed-off-by: Billy Zha <jinzha1@microsoft.com>

Merge branch 'attach' of https://github.com/qweeah/oras into attach

13ca66c

Rename loading manifest annotations

fe4158b

Signed-off-by: Billy Zha <jinzha1@microsoft.com>

Code clean

859d184

Signed-off-by: Billy Zha <jinzha1@microsoft.com>

Skip subject when attaching

31450a8

Signed-off-by: Billy Zha <jinzha1@microsoft.com>

shizhMSFT approved these changes Jul 8, 2022

View reviewed changes

shizhMSFT merged commit 8125941 into oras-project:main Jul 8, 2022

qweeah deleted the attach branch July 11, 2022 05:10

shizhMSFT mentioned this pull request Jul 26, 2022

Specification for ORAS attach command #424

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add attach command #433

Add attach command #433

qweeah commented Jul 4, 2022 •

edited

Loading

Wwwsylvia Jul 8, 2022

Wwwsylvia Jul 8, 2022

Wwwsylvia Jul 8, 2022

Wwwsylvia Jul 8, 2022

qweeah Jul 8, 2022

Wwwsylvia Jul 8, 2022

qweeah Jul 8, 2022

shizhMSFT left a comment

Add attach command #433

Add attach command #433

Conversation

qweeah commented Jul 4, 2022 • edited Loading

Wwwsylvia Jul 8, 2022

Choose a reason for hiding this comment

Wwwsylvia Jul 8, 2022

Choose a reason for hiding this comment

Wwwsylvia Jul 8, 2022

Choose a reason for hiding this comment

Wwwsylvia Jul 8, 2022

Choose a reason for hiding this comment

qweeah Jul 8, 2022

Choose a reason for hiding this comment

Wwwsylvia Jul 8, 2022

Choose a reason for hiding this comment

qweeah Jul 8, 2022

Choose a reason for hiding this comment

shizhMSFT left a comment

Choose a reason for hiding this comment

qweeah commented Jul 4, 2022 •

edited

Loading