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

Update long description indentation for alpha #789

Conversation

tylerslaton
Copy link
Contributor

Signed-off-by: Tyler Slaton tyslaton@redhat.com

Description of the change:
Adjusting the spacing of the alpha subcommands to have appropriate indentation.

Motivation for the change:

The output for the alpha bundle command, for example, looks wonky. Click to see.
$ ./bin/opm alpha bundle --help
The "opm alpha bundle build" command will generate operator
        bundle metadata if needed and build bundle image with operator manifest
        and metadata for a specific version.

        For example: The command will generate annotations.yaml metadata plus
        Dockerfile for bundle image and then build a container image from
        provided operator bundle manifests generated metadata
        e.g. "quay.io/example/operator:v0.0.1".

        After the build process is completed, a container image would be built
        locally in docker and available to push to a container registry.

        $ opm alpha bundle build --directory /test/0.1.0/ --tag quay.io/example/operator:v0.1.0 \
		--package test-operator --channels stable,beta --default stable --overwrite

		Note:
		* Bundle image is not runnable.
		* All manifests yaml must be in the same directory.

Reviewer Checklist

  • Implementation matches the proposed design, or proposal is updated to match implementation
  • Sufficient unit test coverage
  • Sufficient end-to-end test coverage
  • Docs updated or added to /docs
  • Commit messages sensible and descriptive

@codecov
Copy link

codecov bot commented Sep 23, 2021

Codecov Report

Merging #789 (33fcfca) into master (8d805a2) will not change coverage.
The diff coverage is n/a.

❗ Current head 33fcfca differs from pull request most recent head b0e1aa7. Consider uploading reports for the commit b0e1aa7 to get more accurate results
Impacted file tree graph

@@           Coverage Diff           @@
##           master     #789   +/-   ##
=======================================
  Coverage   50.62%   50.62%           
=======================================
  Files         102      102           
  Lines        8898     8898           
=======================================
  Hits         4505     4505           
  Misses       3542     3542           
  Partials      851      851           

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 8d805a2...b0e1aa7. Read the comment docs.

Signed-off-by: Tyler Slaton <tyslaton@redhat.com>
@timflannagan
Copy link
Contributor

/lgtm

@openshift-ci openshift-ci bot added the lgtm Indicates that a PR is ready to be merged. label Sep 23, 2021
Copy link
Member

@njhale njhale left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

/approve

@openshift-ci
Copy link
Contributor

openshift-ci bot commented Sep 23, 2021

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: njhale, tylerslaton

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@openshift-ci openshift-ci bot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Sep 23, 2021
@openshift-merge-robot openshift-merge-robot merged commit d21bd8f into operator-framework:master Sep 23, 2021
akihikokuroda pushed a commit to akihikokuroda/operator-registry that referenced this pull request Sep 30, 2021
Signed-off-by: Tyler Slaton <tyslaton@redhat.com>
Signed-off-by: akihikokuroda <akihikokuroda2020@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
approved Indicates a PR has been approved by an approver from all required OWNERS files. lgtm Indicates that a PR is ready to be merged.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants