Skip to content

Conversation

@tatsuya0429
Copy link
Contributor

@tatsuya0429 tatsuya0429 commented Feb 4, 2024

What this PR does / why we need it:
Add authentication to GitHub Container Registry to the Prerequisites section in QuickStart Page.

I followed the procedure in QuickStart according to the document, but without GitHub Container Registry authentication, I got the following error, so I added it to the Prerequisites section.

Installing the controlplane in quickstart mode...
Failed to install PipeCD control plane!!
github.com/pipe-cd/pipecd/pkg/app/pipectl/cmd/quickstart.(*command).run
        /home/runner/work/pipecd/pipecd/pkg/app/pipectl/cmd/quickstart/quickstart.go:114
github.com/pipe-cd/pipecd/pkg/cli.runWithContext
        /home/runner/work/pipecd/pipecd/pkg/cli/cmd.go:95
github.com/pipe-cd/pipecd/pkg/cli.WithContext.func1
        /home/runner/work/pipecd/pipecd/pkg/cli/cmd.go:51
github.com/spf13/cobra.(*Command).execute
        /home/runner/go/pkg/mod/github.com/spf13/[email protected]/command.go:842
github.com/spf13/cobra.(*Command).ExecuteC
        /home/runner/go/pkg/mod/github.com/spf13/[email protected]/command.go:950
github.com/spf13/cobra.(*Command).Execute
        /home/runner/go/pkg/mod/github.com/spf13/[email protected]/command.go:887
github.com/pipe-cd/pipecd/pkg/cli.(*App).Run
        /home/runner/work/pipecd/pipecd/pkg/cli/app.go:69
main.main
        /home/runner/work/pipecd/pipecd/cmd/pipectl/main.go:46
runtime.main
        /opt/hostedtoolcache/go/1.20.5/x64/src/runtime/proc.go:250
2024/02/04 21:55:59 exit status 1: Error: failed to download "oci://ghcr.io/pipe-cd/chart/pipecd" at version "v0.45.4

Which issue(s) this PR fixes: no

Fixes #

Does this PR introduce a user-facing change?: no

  • How are users affected by this change:
  • Is this breaking change:
  • How to migrate (if breaking change):

Copy link
Member

@ffjlabo ffjlabo left a comment

Choose a reason for hiding this comment

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

Nice catch 👍 Thank you for the contribution!

Could you signoff your commits with git commit -s 🙏
https://github.com/pipe-cd/pipecd/blob/master/CONTRIBUTING.md#contributor-license-agreement

Also, could you add the same line to the other version's docs?

  • docs/content/en/docs-dev/quickstart/_index.md
  • docs/content/en/docs-v0.39.x/quickstart/_index.md
  • docs/content/en/docs-v0.40.x/quickstart/_index.md
  • docs/content/en/docs-v0.41.x/quickstart/_index.md
  • docs/content/en/docs-v0.42.x/quickstart/_index.md
  • docs/content/en/docs-v0.43.x/quickstart/_index.md
  • docs/content/en/docs-v0.44.x/quickstart/_index.md

@codecov
Copy link

codecov bot commented Feb 4, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (5cca5e7) 31.03% compared to head (af2613b) 31.03%.

Additional details and impacted files
@@           Coverage Diff           @@
##           master    #4773   +/-   ##
=======================================
  Coverage   31.03%   31.03%           
=======================================
  Files         225      225           
  Lines       26353    26353           
=======================================
  Hits         8179     8179           
  Misses      17521    17521           
  Partials      653      653           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@tatsuya0429
Copy link
Contributor Author

@ffjlabo
Thank you for your comment.
Sorry I forgot the signoff part of commit.
I have completed adding the prerequisite section for the above markdown as well.
Please check my commits.

Copy link
Member

@ffjlabo ffjlabo left a comment

Choose a reason for hiding this comment

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

LGTM 👍

@ffjlabo ffjlabo enabled auto-merge (squash) February 5, 2024 23:55
Copy link
Member

@t-kikuc t-kikuc left a comment

Choose a reason for hiding this comment

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

Thank you so much!!

@ffjlabo ffjlabo merged commit cf7aa73 into pipe-cd:master Feb 6, 2024
@github-actions github-actions bot mentioned this pull request Feb 6, 2024
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.

3 participants