doc: verify local files #1386
Merged
doc: verify local files #1386
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Signed-off-by: Billy Zha <jinzha1@microsoft.com>
qweeah
requested review from
sajayantony,
shizhMSFT,
SteveLasker and
TerryHowe
as code owners
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #1386 +/- ##
==========================================
- Coverage 85.07% 85.01% -0.06%
==========================================
Files 107 107
Lines 3805 3805
==========================================
- Hits 3237 3235 -2
- Misses 339 341 +2
Partials 229 229 ☔ View full report in Codecov by Sentry. |
shizhMSFT
reviewed
May 27, 2024
ti-chi-bot bot
referenced
this pull request
in PingCAP-QE/artifacts
Jul 5, 2024
[](https://renovatebot.com) This PR contains the following updates: | Package | Update | Change | |---|---|---| | [oras-project/oras](https://togithub.com/oras-project/oras) | minor | `v1.1.0` -> `v1.2.0` | --- > [!WARNING] > Some dependencies could not be looked up. Check the Dependency Dashboard for more information. --- ### Release Notes <details> <summary>oras-project/oras (oras-project/oras)</summary> ### [`v1.2.0`](https://togithub.com/oras-project/oras/releases/tag/v1.2.0) [Compare Source](https://togithub.com/oras-project/oras/compare/v1.1.0...v1.2.0) #### New Features - `oras` is compliant with OCI [image-spec v1.1.0](https://togithub.com/opencontainers/image-spec/blob/v1.1.0) and [distribution-spec v1.1.0](https://togithub.com/opencontainers/distribution-spec/tree/v1.1.0) - Introduce brand-new default terminal experience - Show live progress for the following commands: - `oras copy` - `oras pull` - `oras push` - `oras attach` - `oras blob fetch` - `oras blob push` - The new terminal experience can be turned off via the preview flag `--no-tty` - Support deletion of manifests and blobs in OCI image layout - Support X.509 mTLS authentication with OCI registries #### Preview Features - **BREAKING CHANGE** Registries supporting `Referrers API` prior to [distribution-spec v1.1.0-rc4](https://togithub.com/opencontainers/distribution-spec/tree/v1.1.0-rc4) will fall back to `Referrers tag schema`, causing unexpected results of `oras attach` and `oras discover` commands - Introduce `--platform` to `oras attach` for better multi-arch attaching experience, which allows adding referrer artifact to a specific sub-platform - Re-purpose the flag `--recursive` of `oras cp` from [extended copy](https://oras.land/docs/client_libraries/overview#extended-copy) to copy an artifact or a multi-arch image and its referrers - Promote `--image-spec` to a preview flag from experimental #### Experimental Features - **BREAKING CHANGE** `oras discover` shows `tree` view output by default - Introduce formatted output via `--format` by implementing the [specification](https://togithub.com/oras-project/oras/blob/v1.2.0/docs/proposals/formatted-output.md) - Formatted output is available to the following commands: - `oras pull` - `oras push` - `oras attach` - `oras discover` - `oras manifest fetch` - Examples: - `--format json` to print operation result as a JSON object - `--format "go-template={{ .digest }}"` to print the digest of the manifest using [Go template](https://pkg.go.dev/text/template) - Template can also be specified by `--template` - Introduce `oras resolve` to get the digest of an artifact #### Deprecation - `oras discover`: `--output` is marked as deprecated and succeeded by `--format` #### Bug Fixes - Fix [#​1079](https://togithub.com/oras-project/oras/issues/1079): Snaps build cannot read default credentials file - Fix [#​1096](https://togithub.com/oras-project/oras/issues/1096): Mixed request number in the debug mode - Fix [#​1106](https://togithub.com/oras-project/oras/issues/1106): Flag `--plain-http=false` does not work for local registries - Fix [#​1129](https://togithub.com/oras-project/oras/issues/1129): `oras cp -r` fails if index has a child manifest as subject - Minor fixes #### Other Changes - Improve UX - `oras discover`: show placeholder when `artifactType` is not presented in an index referrer - `oras push`: show artifact type when pushing files - Improve error message based on [ORAS CLI error handling guildline](https://togithub.com/oras-project/oras/blob/v1.2.0/docs/proposals/error-handling-guideline.md) - Improve identity token input by a new flag `--identity-token` to replace `--password` without `--username` - Improve performance - Reduce authentication request count for`oras copy`, `oras manifest delete`, and `oras blob delete` - Support blob mounting across repositories in the same registry for `oras copy` - Update dependencies - Update to Golang `1.22.3` - Minor security enhancements *** ### What's Changed Since RC.1 #### Other Changes - Improve documentation - Update dependencies #### Detailed Commits - bump: tag and release ORAS CLI v1.2.0-rc.1 by [@​qweeah](https://togithub.com/qweeah) in [https://github.com/oras-project/oras/pull/1381](https://togithub.com/oras-project/oras/pull/1381) - fix: remove non-classic snap plugins by [@​qweeah](https://togithub.com/qweeah) in [https://github.com/oras-project/oras/pull/1383](https://togithub.com/oras-project/oras/pull/1383) - fix: oras cp documentation by [@​TerryHowe](https://togithub.com/TerryHowe) in [https://github.com/oras-project/oras/pull/1384](https://togithub.com/oras-project/oras/pull/1384) - build(deps): bump actions/checkout from 3 to 4 by [@​dependabot](https://togithub.com/dependabot) in [https://github.com/oras-project/oras/pull/1385](https://togithub.com/oras-project/oras/pull/1385) - refactor: Get rid of deprecated PrintStatus method by [@​TerryHowe](https://togithub.com/TerryHowe) in [https://github.com/oras-project/oras/pull/1378](https://togithub.com/oras-project/oras/pull/1378) - build(deps): bump github.com/onsi/ginkgo/v2 from 2.17.3 to 2.18.0 in /test/e2e by [@​dependabot](https://togithub.com/dependabot) in [https://github.com/oras-project/oras/pull/1388](https://togithub.com/oras-project/oras/pull/1388) - build(deps): bump github.com/onsi/ginkgo/v2 from 2.18.0 to 2.19.0 in /test/e2e by [@​dependabot](https://togithub.com/dependabot) in [https://github.com/oras-project/oras/pull/1390](https://togithub.com/oras-project/oras/pull/1390) - chore: Remove deprecated PrintStatus method by [@​TerryHowe](https://togithub.com/TerryHowe) in [https://github.com/oras-project/oras/pull/1389](https://togithub.com/oras-project/oras/pull/1389) - doc: verify local files by [@​qweeah](https://togithub.com/qweeah) in [https://github.com/oras-project/oras/pull/1386](https://togithub.com/oras-project/oras/pull/1386) - fix: remove call to deprecated print by [@​TerryHowe](https://togithub.com/TerryHowe) in [https://github.com/oras-project/oras/pull/1392](https://togithub.com/oras-project/oras/pull/1392) **Full Changelog**: oras-project/oras@v1.2.0-rc.1...v1.2.0 #### Notes This release was signed with `46D3 369B 393F 6F82 71FD 1CE8 F86E C70D 2B0C 404F` ([@​qweeah](https://togithub.com/qweeah)'s GPG key) which can be found [here](https://togithub.com/qweeah.gpg). </details> --- ### Configuration 📅 **Schedule**: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined). 🚦 **Automerge**: Disabled by config. Please merge this manually once you are satisfied. ♻ **Rebasing**: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox. 🔕 **Ignore**: Close this PR and you won't be reminded about this update again. --- - [ ] <!-- rebase-check -->If you want to rebase/retry this PR, check this box --- This PR has been generated by [Mend Renovate](https://www.mend.io/free-developer-tools/renovate/). View repository job log [here](https://developer.mend.io/github/PingCAP-QE/artifacts). <!--renovate-debug:eyJjcmVhdGVkSW5WZXIiOiIzNy4zNzcuOCIsInVwZGF0ZWRJblZlciI6IjM3LjQyMS45IiwidGFyZ2V0QnJhbmNoIjoibWFpbiIsImxhYmVscyI6WyJoZWxwIHdhbnRlZCJdfQ==--> Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
](https://renovatebot.com){kind=link}
This was referenced Jul 8, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What this PR does / why we need it:
This PR adds doc on how to use format output to verify local files without pulling the whole artifact. Related to #1368.