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

docs: added install method #4875

Merged
merged 4 commits into from
Apr 18, 2024
Merged

Conversation

ponkio-o
Copy link
Contributor

What this PR does / why we need it:
I added install method using aquaproj/aqua.
The aqua is a declarative CLI version manager, recently adopted by various japanese tech companies. Our company also uses it. (ref)

aqua-registry (It's like asdf-plugin) has been addressed in the following PR and is now available in v4.163.0.
aquaproj/aqua-registry#21955

Which issue(s) this PR fixes:
I added aqua to the pipectl command installation instructions.

Does this PR introduce a user-facing change?:
No.

@t-kikuc
Copy link
Member

t-kikuc commented Apr 18, 2024

@ponkio-o
Thank you so much for your great PRs, including aqua-registry's one!
It will help PipeCD reach more developers!

At first, please see https://github.com/pipe-cd/pipecd/pull/4875/checks?check_run_id=23936239937 and pass the DCO. (roughly, you need git commit -s)

t-kikuc and others added 2 commits April 18, 2024 09:16
* Fix typo: archive->achieve

Signed-off-by: t-kikuc <tkikuchi07f@gmail.com>

* Fix type: deployment->development

Signed-off-by: t-kikuc <tkikuchi07f@gmail.com>

* Fix typos of 'achieve' and 'under development' in older docs

Signed-off-by: t-kikuc <tkikuchi07f@gmail.com>

---------

Signed-off-by: t-kikuc <tkikuchi07f@gmail.com>
Signed-off-by: ponkio-o <29038315+ponkio-o@users.noreply.github.com>
Signed-off-by: ponkio-o <29038315+ponkio-o@users.noreply.github.com>
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.

The guide worked well and pipectl&piped are installed successfully by aqua!

For merging, would you copy the changes to the following two?:

  • docs/content/en/docs-v0.47.x/quickstart/_index.md
  • docs/content/en/docs-v0.47.x/user-guide/command-line-tool.md

That's because

@khanhtc1202
Copy link
Member

@t-kikuc @ponkio-o
We can use make release/docs version=v0.47.0 to sync changes in docs-dev/ to version v0.47.0 docs without manual copy 😉

Signed-off-by: ponkio-o <29038315+ponkio-o@users.noreply.github.com>
@ponkio-o
Copy link
Contributor Author

@t-kikuc @khanhtc1202 Thank you for review.
I synced to v0.47.x directory on the following commit.
541870c

@ponkio-o ponkio-o requested a review from t-kikuc April 18, 2024 02:58
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 for your amazing PR!!!!!!!

We'd like to add the guide for piped too in the future.
maybe here: https://pipecd.dev/docs/installation/install-piped/installing-on-single-machine/

Copy link
Member

@khanhtc1202 khanhtc1202 left a comment

Choose a reason for hiding this comment

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

🚀🌝

@khanhtc1202 khanhtc1202 enabled auto-merge (squash) April 18, 2024 05:32
@khanhtc1202 khanhtc1202 merged commit 82cb94b into pipe-cd:master Apr 18, 2024
11 checks passed
@github-actions github-actions bot mentioned this pull request Apr 22, 2024
khanhtc1202 pushed a commit that referenced this pull request Apr 22, 2024
khanhtc1202 pushed a commit that referenced this pull request Apr 22, 2024
Signed-off-by: khanhtc1202 <khanhtc1202@gmail.com>
khanhtc1202 added a commit that referenced this pull request Apr 22, 2024
#4883 #4887 #4885 #4886 #4884 #4880 (#4890)

* Update contributors list (#4866)

Signed-off-by: khanhtc1202 <khanhtc1202@gmail.com>

* Use valid semver in run/pipecd command (#4851)

* Use valid semver in run/pipecd command

Signed-off-by: David <19214156+dgannon991@users.noreply.github.com>

* Swapped to simpler local version

Signed-off-by: David Gannon <19214156+dgannon991@users.noreply.github.com>

* Include a comment explaining why we hard coded

Signed-off-by: David Gannon <19214156+dgannon991@users.noreply.github.com>

---------

Signed-off-by: David <19214156+dgannon991@users.noreply.github.com>
Signed-off-by: David Gannon <19214156+dgannon991@users.noreply.github.com>
Signed-off-by: khanhtc1202 <khanhtc1202@gmail.com>

* Support Canary & Blue/Green for ECS by `pipectl init` (#4801)

* Add expected YAML for kustomize

Signed-off-by: t-kikuc <tkikuchi07f@gmail.com>

* Add Kustomize pattern for pipectl init

Signed-off-by: t-kikuc <tkikuchi07f@gmail.com>

* Add Helm pattern for pipectl init

Signed-off-by: t-kikuc <tkikuchi07f@gmail.com>

* Add options for Helm

Signed-off-by: t-kikuc <tkikuchi07f@gmail.com>

* fix typo

Signed-off-by: t-kikuc <tkikuchi07f@gmail.com>

* Add ECS canary for pipectl init

Signed-off-by: t-kikuc <tkikuchi07f@gmail.com>

* Add pipectl init status

Signed-off-by: t-kikuc <tkikuchi07f@gmail.com>

* add init cmd to pipectl doc

Signed-off-by: t-kikuc <tkikuchi07f@gmail.com>

* add pipectl init explanation

Signed-off-by: t-kikuc <tkikuchi07f@gmail.com>

* fi pipectl init status

Signed-off-by: t-kikuc <tkikuchi07f@gmail.com>

* Embed the simple AnalysisStage in pipeline by default

Signed-off-by: t-kikuc <tkikuchi07f@gmail.com>

* Merge fix origin/master into pipectl-init-ecs-canary

Signed-off-by: t-kikuc <tkikuchi07f@gmail.com>

* fix prompt message and default value

Signed-off-by: t-kikuc <tkikuchi07f@gmail.com>

* Fix output YAML structure by generic structs

Signed-off-by: t-kikuc <tkikuchi07f@gmail.com>

* Support Blue/Green for ECS by pipectl init

Signed-off-by: t-kikuc <tkikuchi07f@gmail.com>

* omitempty Percentage

Signed-off-by: t-kikuc <tkikuchi07f@gmail.com>

* Changed default values for simpler config

Signed-off-by: t-kikuc <tkikuchi07f@gmail.com>

* Rename funcs to avoid name conflicts with other platforms

Signed-off-by: t-kikuc <tkikuchi07f@gmail.com>

---------

Signed-off-by: t-kikuc <tkikuchi07f@gmail.com>
Co-authored-by: Khanh Tran <32532742+khanhtc1202@users.noreply.github.com>
Signed-off-by: khanhtc1202 <khanhtc1202@gmail.com>

* [doc] Fix typo x2 in DeploymentChain (#4872)

* Fix typo: archive->achieve

Signed-off-by: t-kikuc <tkikuchi07f@gmail.com>

* Fix type: deployment->development

Signed-off-by: t-kikuc <tkikuchi07f@gmail.com>

* Fix typos of 'achieve' and 'under development' in older docs

Signed-off-by: t-kikuc <tkikuchi07f@gmail.com>

---------

Signed-off-by: t-kikuc <tkikuchi07f@gmail.com>
Signed-off-by: khanhtc1202 <khanhtc1202@gmail.com>

* docs: added install method (#4875)

Signed-off-by: khanhtc1202 <khanhtc1202@gmail.com>

* Fix unable to use SecretEncryption and Attachment features at the same time (#4855)

* Add test to mention error with go templating

Signed-off-by: khanhtc1202 <khanhtc1202@gmail.com>

* Reimplement sourceprosser logic

Signed-off-by: khanhtc1202 <khanhtc1202@gmail.com>

* SourceProssesor without processor should be marked as error

Signed-off-by: khanhtc1202 <khanhtc1202@gmail.com>

* Add test

Signed-off-by: khanhtc1202 <khanhtc1202@gmail.com>

* Enable perform template processing in chain

Signed-off-by: khanhtc1202 <khanhtc1202@gmail.com>

* Fix typo

Signed-off-by: khanhtc1202 <khanhtc1202@gmail.com>

---------

Signed-off-by: khanhtc1202 <khanhtc1202@gmail.com>

* Add a caution comment of scrape_interval (#4869)

* Add caution comment of scrape_interval

Signed-off-by: t-kikuc <tkikuchi07f@gmail.com>

* Remove concrete value

Signed-off-by: t-kikuc <tkikuchi07f@gmail.com>

* Fix to commit hash of v0.47.0 to fix the ref position

Signed-off-by: t-kikuc <tkikuchi07f@gmail.com>

---------

Signed-off-by: t-kikuc <tkikuchi07f@gmail.com>
Signed-off-by: khanhtc1202 <khanhtc1202@gmail.com>

* Rewrite pipectl installation docs (#4877)

Signed-off-by: khanhtc1202 <khanhtc1202@gmail.com>

* Fix typo (#4878)

Signed-off-by: khanhtc1202 <khanhtc1202@gmail.com>

* Set initial-branch on git init (#4882)

Signed-off-by: t-kikuc <tkikuchi07f@gmail.com>
Signed-off-by: khanhtc1202 <khanhtc1202@gmail.com>

* Update contributors list (#4883)

Signed-off-by: t-kikuc <tkikuchi07f@gmail.com>
Signed-off-by: khanhtc1202 <khanhtc1202@gmail.com>

* Bump golang.org/x/net from 0.17.0 to 0.23.0 (#4887)

Signed-off-by: khanhtc1202 <khanhtc1202@gmail.com>

* Bump golang.org/x/net in /tool/actions-plan-preview (#4885)

Signed-off-by: khanhtc1202 <khanhtc1202@gmail.com>

* Bump golang.org/x/net from 0.17.0 to 0.23.0 in /tool/actions-gh-release (#4886)

Signed-off-by: khanhtc1202 <khanhtc1202@gmail.com>

* Update default versions of kubectl, kustomize and helm in configuration-reference.md (#4884)

Signed-off-by: khanhtc1202 <khanhtc1202@gmail.com>

* Add Homebrew Formula (#4880)

Signed-off-by: khanhtc1202 <khanhtc1202@gmail.com>

---------

Signed-off-by: khanhtc1202 <khanhtc1202@gmail.com>
Signed-off-by: David <19214156+dgannon991@users.noreply.github.com>
Signed-off-by: David Gannon <19214156+dgannon991@users.noreply.github.com>
Signed-off-by: t-kikuc <tkikuchi07f@gmail.com>
Co-authored-by: David Gannon <19214156+dgannon991@users.noreply.github.com>
Co-authored-by: Tetsuya Kikuchi <97105818+t-kikuc@users.noreply.github.com>
Co-authored-by: YuyaKoda <29038315+ponkio-o@users.noreply.github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Co-authored-by: Shinichi Nishimura <nshmura.s@gmail.com>
Co-authored-by: Shohei Ueda <30958501+peaceiris@users.noreply.github.com>
@github-actions github-actions bot mentioned this pull request May 13, 2024
@github-actions github-actions bot mentioned this pull request Jun 12, 2024
@github-actions github-actions bot mentioned this pull request Jul 4, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
No open projects
Status: Done
Development

Successfully merging this pull request may close these issues.

3 participants