Merge branch 'master' into snyk-fix-849485358b2bdf026ba543a01b75d948

.github/PULL_REQUEST_TEMPLATE.md

@@ -1,4 +1,6 @@
-**What this PR does / why we need it**:
+**What this PR does**:
+
+**Why we need it**:
 
 **Which issue(s) this PR fixes**:
 

.github/labeler.yaml

@@ -28,3 +28,5 @@ area/tool:
 
 area/pipedv1:
 - pkg/app/pipedv1/**/*
+- pkg/configv1/*
+- pkg/configv1/**/*

.github/workflows/publish_image_chart.yaml

@@ -146,3 +146,43 @@ jobs:
           event-name: helm-release
           labels: helmRepo=pipecd
           data: ${{ env.PIPECD_VERSION }}
+
+  release-quickstart-manifests:
+    runs-on: ubuntu-latest
+    needs: artifacts
+    if: startsWith(github.ref, 'refs/tags/')
+    permissions:
+      contents: write
+      pull-requests: write
+    steps:
+      # setup tools and repositories
+      - name: Install helm
+        uses: Azure/setup-helm@v1
+        with:
+          version: ${{ env.HELM_VERSION }}
+      - uses: actions/checkout@v3
+        with:
+          fetch-depth: 0
+          ref: master
+
+      # Building and publishing quickstart manifests.
+      # we use `github.ref_name` to get the tag name without the `refs/tags/` prefix.
+      - name: Build quickstart manifests
+        run: |
+          helm template pipecd oci://ghcr.io/pipe-cd/chart/pipecd --version ${{ github.ref_name }} -n pipecd -f quickstart/control-plane-values.yaml > quickstart/manifests/control-plane.yaml
+          helm template piped oci://ghcr.io/pipe-cd/chart/piped --version ${{ github.ref_name }} -n pipecd --set quickstart.enabled=true --set quickstart.pipedId=\<YOUR_PIPED_ID\> --set quickstart.pipedKeyData=\<YOUR_PIPED_KEY_DATA\> > quickstart/manifests/piped.yaml
+      - name: Publish quickstart manifests
+        uses: peter-evans/create-pull-request@v6
+        with:
+          title: "[bot] Publish quickstart manifests"
+          commit-message: "[bot] Publish quickstart manifests"
+          branch: "create-pull-request/publish-quickstart-manifests"
+          body: |
+            Automated changes by [create-pull-request](https://github.com/peter-evans/create-pull-request) GitHub action.
+            The workflow is defined [here](https://github.com/pipe-cd/pipecd/blob/master/.github/workflows/publish_image_chart.yaml).
+
+            **Note:** You need to **close and reopen this PR** manually to trigger status check workflows. (Or just click `Update branch` if possible.)
+            For details, see https://github.com/peter-evans/create-pull-request/blob/main/docs/concepts-guidelines.md#triggering-further-workflow-runs.
+          delete-branch: true
+          signoff: true
+          token: ${{ secrets.GITHUB_TOKEN }}

CONTRIBUTING.md

@@ -2,6 +2,7 @@
 
 If you're interested in contributing to PipeCD, this document will provide clear instructions on how to get involved.
 
+> Note: Don't bother reading policies and flows, just want to manipulate the code? Jump to the [Development](#development) section.
 
 The [Open Source Guides](https://opensource.guide/) website offers a collection of resources for individuals, communities, and companies who want to learn how to run and contribute to an open source project. Both contributors and newcomers to open source will find the following guides especially helpful:
 

README.md

@@ -1,3 +1,4 @@
+[![OpenSSF Best Practices](https://www.bestpractices.dev/projects/7489/badge)](https://www.bestpractices.dev/projects/7489)
 [![Build](https://github.com/pipe-cd/pipecd/actions/workflows/build.yaml/badge.svg)](https://github.com/pipe-cd/pipecd/actions/workflows/build.yaml)
 [![Test](https://github.com/pipe-cd/pipecd/actions/workflows/test.yaml/badge.svg)](https://github.com/pipe-cd/pipecd/actions/workflows/test.yaml)
 [![Go Report Card](https://goreportcard.com/badge/github.com/pipe-cd/pipecd)](https://goreportcard.com/report/github.com/pipe-cd/pipecd)
@@ -86,14 +87,14 @@ You can find a list of publicly recognized users of the PipeCD in the [ADOPTERS.
 <a href="https://github.com/cakecatz"><img src="https://avatars.githubusercontent.com/u/6136383?v=4" title="cakecatz" width="80" height="80"></a>
 <a href="https://github.com/knanao"><img src="https://avatars.githubusercontent.com/u/50069775?v=4" title="knanao" width="80" height="80"></a>
 <a href="https://github.com/t-kikuc"><img src="https://avatars.githubusercontent.com/u/97105818?v=4" title="t-kikuc" width="80" height="80"></a>
-<a href="https://github.com/apps/dependabot"><img src="https://avatars.githubusercontent.com/in/29110?v=4" title="dependabot[bot]" width="80" height="80"></a>
 <a href="https://github.com/ffjlabo"><img src="https://avatars.githubusercontent.com/u/40124947?v=4" title="ffjlabo" width="80" height="80"></a>
+<a href="https://github.com/apps/dependabot"><img src="https://avatars.githubusercontent.com/in/29110?v=4" title="dependabot[bot]" width="80" height="80"></a>
+<a href="https://github.com/Warashi"><img src="https://avatars.githubusercontent.com/u/3600530?v=4" title="Warashi" width="80" height="80"></a>
 <a href="https://github.com/kentakozuka"><img src="https://avatars.githubusercontent.com/u/16733673?v=4" title="kentakozuka" width="80" height="80"></a>
 <a href="https://github.com/stormcat24"><img src="https://avatars.githubusercontent.com/u/919840?v=4" title="stormcat24" width="80" height="80"></a>
 <a href="https://github.com/Hosshii"><img src="https://avatars.githubusercontent.com/u/49914427?v=4" title="Hosshii" width="80" height="80"></a>
 <a href="https://github.com/funera1"><img src="https://avatars.githubusercontent.com/u/60760935?v=4" title="funera1" width="80" height="80"></a>
 <a href="https://github.com/sanposhiho"><img src="https://avatars.githubusercontent.com/u/44139130?v=4" title="sanposhiho" width="80" height="80"></a>
-<a href="https://github.com/Warashi"><img src="https://avatars.githubusercontent.com/u/3600530?v=4" title="Warashi" width="80" height="80"></a>
 <a href="https://github.com/Szarny"><img src="https://avatars.githubusercontent.com/u/26561120?v=4" title="Szarny" width="80" height="80"></a>
 <a href="https://github.com/sivchari"><img src="https://avatars.githubusercontent.com/u/55221074?v=4" title="sivchari" width="80" height="80"></a>
 <a href="https://github.com/kevin-namba"><img src="https://avatars.githubusercontent.com/u/68955641?v=4" title="kevin-namba" width="80" height="80"></a>
@@ -103,10 +104,10 @@ You can find a list of publicly recognized users of the PipeCD in the [ADOPTERS.
 <a href="https://github.com/caniszczyk"><img src="https://avatars.githubusercontent.com/u/63777?v=4" title="caniszczyk" width="80" height="80"></a>
 <a href="https://github.com/chaspy"><img src="https://avatars.githubusercontent.com/u/10370988?v=4" title="chaspy" width="80" height="80"></a>
 <a href="https://github.com/gkuga"><img src="https://avatars.githubusercontent.com/u/33643470?v=4" title="gkuga" width="80" height="80"></a>
-<a href="https://github.com/nnnkkk7"><img src="https://avatars.githubusercontent.com/u/68233204?v=4" title="nnnkkk7" width="80" height="80"></a>
 <a href="https://github.com/golemiso"><img src="https://avatars.githubusercontent.com/u/3282656?v=4" title="golemiso" width="80" height="80"></a>
-<a href="https://github.com/karamaru-alpha"><img src="https://avatars.githubusercontent.com/u/38310693?v=4" title="karamaru-alpha" width="80" height="80"></a>
+<a href="https://github.com/nnnkkk7"><img src="https://avatars.githubusercontent.com/u/68233204?v=4" title="nnnkkk7" width="80" height="80"></a>
 <a href="https://github.com/ouchi2501"><img src="https://avatars.githubusercontent.com/u/11391317?v=4" title="ouchi2501" width="80" height="80"></a>
+<a href="https://github.com/karamaru-alpha"><img src="https://avatars.githubusercontent.com/u/38310693?v=4" title="karamaru-alpha" width="80" height="80"></a>
 <a href="https://github.com/TonkyH"><img src="https://avatars.githubusercontent.com/u/50762864?v=4" title="TonkyH" width="80" height="80"></a>
 <a href="https://github.com/dgannon991"><img src="https://avatars.githubusercontent.com/u/19214156?v=4" title="dgannon991" width="80" height="80"></a>
 <a href="https://github.com/tnqv"><img src="https://avatars.githubusercontent.com/u/23372024?v=4" title="tnqv" width="80" height="80"></a>
@@ -118,6 +119,7 @@ You can find a list of publicly recognized users of the PipeCD in the [ADOPTERS.
 <a href="https://github.com/TakumaKurosawa"><img src="https://avatars.githubusercontent.com/u/39955827?v=4" title="TakumaKurosawa" width="80" height="80"></a>
 <a href="https://github.com/khanhtc3010"><img src="https://avatars.githubusercontent.com/u/9603918?v=4" title="khanhtc3010" width="80" height="80"></a>
 <a href="https://github.com/tennashi"><img src="https://avatars.githubusercontent.com/u/10219626?v=4" title="tennashi" width="80" height="80"></a>
+<a href="https://github.com/naonao2323"><img src="https://avatars.githubusercontent.com/u/74669884?v=4" title="naonao2323" width="80" height="80"></a>
 <a href="https://github.com/ShotaKitazawa"><img src="https://avatars.githubusercontent.com/u/19530785?v=4" title="ShotaKitazawa" width="80" height="80"></a>
 <a href="https://github.com/Exzrgs"><img src="https://avatars.githubusercontent.com/u/140805585?v=4" title="Exzrgs" width="80" height="80"></a>
 <a href="https://github.com/gotyoooo"><img src="https://avatars.githubusercontent.com/u/6133219?v=4" title="gotyoooo" width="80" height="80"></a>
@@ -136,12 +138,13 @@ You can find a list of publicly recognized users of the PipeCD in the [ADOPTERS.
 <a href="https://github.com/mura-s"><img src="https://avatars.githubusercontent.com/u/4702673?v=4" title="mura-s" width="80" height="80"></a>
 <a href="https://github.com/butterv"><img src="https://avatars.githubusercontent.com/u/15773082?v=4" title="butterv" width="80" height="80"></a>
 <a href="https://github.com/Abirdcfly"><img src="https://avatars.githubusercontent.com/u/5100555?v=4" title="Abirdcfly" width="80" height="80"></a>
+<a href="https://github.com/ntheanh201"><img src="https://avatars.githubusercontent.com/u/29043139?v=4" title="ntheanh201" width="80" height="80"></a>
 <a href="https://github.com/yoiki"><img src="https://avatars.githubusercontent.com/u/39365493?v=4" title="yoiki" width="80" height="80"></a>
 <a href="https://github.com/JohnTitor"><img src="https://avatars.githubusercontent.com/u/25030997?v=4" title="JohnTitor" width="80" height="80"></a>
 <a href="https://github.com/ponkio-o"><img src="https://avatars.githubusercontent.com/u/29038315?v=4" title="ponkio-o" width="80" height="80"></a>
 <a href="https://github.com/testwill"><img src="https://avatars.githubusercontent.com/u/8717479?v=4" title="testwill" width="80" height="80"></a>
 <a href="https://github.com/mugioka"><img src="https://avatars.githubusercontent.com/u/62197019?v=4" title="mugioka" width="80" height="80"></a>
-<a href="https://github.com/naonao2323"><img src="https://avatars.githubusercontent.com/u/74669884?v=4" title="naonao2323" width="80" height="80"></a>
+<a href="https://github.com/Reimei1213"><img src="https://avatars.githubusercontent.com/u/34594195?v=4" title="Reimei1213" width="80" height="80"></a>
 <a href="https://github.com/sZma5a"><img src="https://avatars.githubusercontent.com/u/35451404?v=4" title="sZma5a" width="80" height="80"></a>
 <a href="https://github.com/tatsuya0429"><img src="https://avatars.githubusercontent.com/u/29541999?v=4" title="tatsuya0429" width="80" height="80"></a>
 <a href="https://github.com/tokku5552"><img src="https://avatars.githubusercontent.com/u/69064290?v=4" title="tokku5552" width="80" height="80"></a>
@@ -151,6 +154,7 @@ You can find a list of publicly recognized users of the PipeCD in the [ADOPTERS.
 <a href="https://github.com/pheianox"><img src="https://avatars.githubusercontent.com/u/72671586?v=4" title="pheianox" width="80" height="80"></a>
 <a href="https://github.com/ductnn"><img src="https://avatars.githubusercontent.com/u/22121217?v=4" title="ductnn" width="80" height="80"></a>
 <a href="https://github.com/Forget-C"><img src="https://avatars.githubusercontent.com/u/25631506?v=4" title="Forget-C" width="80" height="80"></a>
+<a href="https://github.com/HoangNguyen689"><img src="https://avatars.githubusercontent.com/u/40779936?v=4" title="HoangNguyen689" width="80" height="80"></a>
 <a href="https://github.com/hongchaodeng"><img src="https://avatars.githubusercontent.com/u/920884?v=4" title="hongchaodeng" width="80" height="80"></a>
 <a href="https://github.com/hori-ryota"><img src="https://avatars.githubusercontent.com/u/2936501?v=4" title="hori-ryota" width="80" height="80"></a>
 <a href="https://github.com/eltociear"><img src="https://avatars.githubusercontent.com/u/22633385?v=4" title="eltociear" width="80" height="80"></a>
@@ -163,7 +167,7 @@ You can find a list of publicly recognized users of the PipeCD in the [ADOPTERS.
 <a href="https://github.com/Lennie"><img src="https://avatars.githubusercontent.com/u/330102?v=4" title="Lennie" width="80" height="80"></a>
 <a href="https://github.com/gitbluf"><img src="https://avatars.githubusercontent.com/u/22802784?v=4" title="gitbluf" width="80" height="80"></a>
 <a href="https://github.com/mi11km"><img src="https://avatars.githubusercontent.com/u/54844746?v=4" title="mi11km" width="80" height="80"></a>
-<a href="https://github.com/foodatbar"><img src="https://avatars.githubusercontent.com/u/60810674?v=4" title="foodatbar" width="80" height="80"></a>
+<a href="https://github.com/phuongdnguyen"><img src="https://avatars.githubusercontent.com/u/60810674?v=4" title="phuongdnguyen" width="80" height="80"></a>
 <a href="https://github.com/chalin"><img src="https://avatars.githubusercontent.com/u/4140793?v=4" title="chalin" width="80" height="80"></a>
 <a href="https://github.com/GotoRen"><img src="https://avatars.githubusercontent.com/u/63791288?v=4" title="GotoRen" width="80" height="80"></a>
 <a href="https://github.com/RikiyaFujii"><img src="https://avatars.githubusercontent.com/u/23261497?v=4" title="RikiyaFujii" width="80" height="80"></a>

RELEASE

@@ -1,6 +1,6 @@
 # Generated by `make release` command.
 # DO NOT EDIT.
-tag: v0.48.9
+tag: v0.49.2
 
 releaseNoteGenerator:
   showCommitter: false

RELEASES.md

@@ -18,29 +18,20 @@ Note: The team can release Release candidates(vX.Y.Z-rcXYZ) for versions at any
 ## Major release
 This refers to the release of new features or breaking changes.
 
-### Confirm the changelog and Create Release Note
-- Run the release script
+### Confirm the changelog and generate docs
+- Run `make release`.
 
   This example assumes that `vX.Y.Z` will be released:
   ```shell
-  make release/init version=vX.Y.Z
-  ````
-
-  `RELEASE` file will be updated.
+  make release version=vX.Y.Z
+  ```
 
-- Push the above changes and Create a pull request to confirm the changelog.
-  You can confirm the changelog through the reviewing comment in pull request by GitHub Actions.
-  For more information, Please see [actions-gh-release](https://github.com/pipe-cd/actions-gh-release).
+  The `RELEASE` file will be updated and docs `vX.Y.x` will be generated.
 
-### Generate document for new version
-- Run the release document script
+- Push the above changes and create a pull request to confirm the changelog.
+  You can confirm the changelog through the reviewing comment in the pull request by [actions-gh-release](https://github.com/pipe-cd/actions-gh-release).
 
-  This example assumes that `vX.Y.Z` will be released:
-  ```shell
-  make release/docs version=vX.Y.Z
-  ````
-
-- Make a pull request to `master` branch with the above changes and get reviews and merge.
+- Get reviews and merge.
 
 ### Cut a new release
 - Before cutting a new release, wait for all jobs in GitHub Actions to pass on the master branch.
@@ -66,12 +57,27 @@ This may also contain some minor features, but ensure that it does NOT contain a
 
 - Get reviews and merge.
 
-### Confirm the changelog and Create Release Note
-- As well as [Major release](https://github.com/pipe-cd/pipecd/blob/master/RELEASES.md#confirm-the-changelog-and-create-release-note), create a pull request to create a release note on the `master` branch.
+### Confirm the changelog and create Release Note
+
+- Run `make release/init`.
+  ```shell
+  make release/init version=vX.Y.Z
+  ```
+
+  The `RELEASE` file will be updated.
+
+- (Optional) if the patch contains changes with docs update, also need to run `make release/docs`
+  ```shell
+  make release/docs version=vX.Y.Z
+  ```
+
+  Note: You can use `make release version=vX.Y.Z` command to perform both init and docs sync tasks.
+
+- Push the above changes and create a pull request to `master` to confirm the changelog.
 
 - Get a review and merge.
 
-### Backport fixes and Release note
+### Backport fixes and Release Note
 - Run `cherry_pick` workflow
   - Label the merged PR you want to cherry pick with `cherry-pick` , `vX.Y.Z`
     (e.g. v0.48.6 https://github.com/pipe-cd/pipecd/pulls?q=is%3Apr+label%3Acherry-pick+is%3Aclosed+label%3Av0.48.6)

cmd/pipecd/README.md

@@ -4,6 +4,7 @@
 ## Prerequisites
 
 - [Go 1.22 or later](https://go.dev/)
+- [NodeJS v20 or later](https://nodejs.org/en/)
 - [Docker](https://www.docker.com/)
 - [kind](https://kind.sigs.k8s.io/docs/user/quick-start/#installation) (If you want to run Control Plane locally)
 - [helm 3.8](https://helm.sh/docs/intro/install/) (If you want to run Control Plane locally)
@@ -22,7 +23,7 @@ For the full list of available commands, please see the Makefile at the root of
 
 ## How to run Control Plane locally
 
-1. Start running a Kubernetes cluster
+1. Start running a Kubernetes cluster (If you don't have any Kubernetes cluster to use)
 
     ``` console
     make kind-up
@@ -53,4 +54,4 @@ For the full list of available commands, please see the Makefile at the root of
     Point your web browser to [http://localhost:8080](http://localhost:8080) to login with the configured static admin account: project = `quickstart`, username = `hello-pipecd`, password = `hello-pipecd`.
 
 ## How to run Piped locally and add an application to your cluster
-See [How to run Piped agent locally](https://github.com/pipe-cd/pipecd/tree/master/cmd/piped#how-to-run-piped-agent-locally).
+See [How to run Piped agent locally](https://github.com/pipe-cd/pipecd/tree/master/cmd/piped#how-to-run-piped-agent-locally).

cmd/pipectl/main.go

@@ -24,7 +24,6 @@ import (
 	"github.com/pipe-cd/pipecd/pkg/app/pipectl/cmd/initialize"
 	"github.com/pipe-cd/pipecd/pkg/app/pipectl/cmd/piped"
 	"github.com/pipe-cd/pipecd/pkg/app/pipectl/cmd/planpreview"
-	"github.com/pipe-cd/pipecd/pkg/app/pipectl/cmd/quickstart"
 	"github.com/pipe-cd/pipecd/pkg/cli"
 )
 
@@ -41,7 +40,6 @@ func main() {
 		planpreview.NewCommand(),
 		piped.NewCommand(),
 		encrypt.NewCommand(),
-		quickstart.NewCommand(),
 		initialize.NewCommand(),
 	)
 

docs/config.toml

@@ -167,6 +167,10 @@ no = 'Sorry to hear that. Please <a href="https://github.com/pipe-cd/pipecd/issu
   githubbranch = "master"
   url = "/docs-dev/"
 
+[[params.versions]]
+  version = "v0.49.x"
+  url = "/docs-v0.49.x/"
+
 [[params.versions]]
   version = "v0.48.x"
   url = "/docs-v0.48.x/"