Deprecate default name of prebuilt branch (#1811)

* Improve traceability (bootstrap-pull-request)

* Deprecate default name of prebuilt branch

* Fix test

* Fix typo

* Fix test

Author: int128

.github/workflows/bootstrap-pull-request.yaml

@@ -59,13 +59,14 @@ jobs:
           cp -av "$GITHUB_WORKSPACE/bootstrap-pull-request/tests/fixtures/prebuilt/." .
           git add .
           git commit -m "Add prebuilt branch for e2e-test of ${GITHUB_REF}"
-          git push origin "HEAD:refs/heads/prebuilt/monorepo-deploy-actions/overlay-${{ github.run_id }}"
+          git push origin "HEAD:refs/heads/bootstrap-pull-request-e2e-prebuilt-${{ github.run_id }}"
 
       - uses: ./bootstrap-pull-request
         with:
           overlay: overlay-${{ github.run_id }}
           namespace: pr-${{ github.event.number }}
           destination-repository: ${{ github.repository }}
+          prebuilt-branch: bootstrap-pull-request-e2e-prebuilt-${{ github.run_id }}
           namespace-manifest: bootstrap-pull-request/tests/fixtures/namespace.yaml
           substitute-variables: NAMESPACE=pr-${{ github.event.number }}
 
@@ -75,6 +76,7 @@ jobs:
           overlay: overlay-${{ github.run_id }}
           namespace: pr-${{ github.event.number }}
           destination-repository: ${{ github.repository }}
+          prebuilt-branch: bootstrap-pull-request-e2e-prebuilt-${{ github.run_id }}
           namespace-manifest: bootstrap-pull-request/tests/fixtures/namespace.yaml
           substitute-variables: NAMESPACE=pr-${{ github.event.number }}
 
@@ -87,4 +89,4 @@ jobs:
         continue-on-error: true
         if: always()
         run: |
-          git push origin --delete "refs/heads/prebuilt/monorepo-deploy-actions/overlay-${{ github.run_id }}"
+          git push origin --delete "refs/heads/bootstrap-pull-request-e2e-prebuilt-${{ github.run_id }}"

bootstrap-pull-request/README.md

@@ -48,6 +48,7 @@ jobs:
           overlay: pr
           namespace: pr-${{ github.event.number }}
           destination-repository: octocat/generated-manifests
+          prebuilt-branch: prebuilt/source-repository/pr
           destination-repository-token: ${{ steps.destination-repository-github-app.outputs.token }}
           namespace-manifest: deploy-config/overlays/pr/namespace.yaml
           substitute-variables: |
@@ -72,12 +73,6 @@ It creates the following directory structure.
         └── generated.yaml
 ```
 
-It assumes that the below name of prebuilt branch exists in the destination repository.
-
-```
-prebuilt/${source-repository}/${overlay}
-```
-
 It bootstraps the namespace branch by the following steps:
 
 1. Delete the outdated application manifests

bootstrap-pull-request/action.yaml

@@ -15,6 +15,9 @@ inputs:
   destination-repository:
     description: Destination repository
     required: true
+  prebuilt-branch:
+    description: Name of prebuilt branch in the destination repository. This input will be required in the future release.
+    required: false
   destination-repository-token:
     description: GitHub token for destination repository
     required: true

bootstrap-pull-request/src/main.ts

@@ -7,6 +7,7 @@ const main = async (): Promise<void> => {
     namespace: core.getInput('namespace', { required: true }),
     sourceRepository: core.getInput('source-repository', { required: true }),
     destinationRepository: core.getInput('destination-repository', { required: true }),
+    prebuiltBranch: core.getInput('prebuilt-branch', { required: false }) || undefined,
     destinationRepositoryToken: core.getInput('destination-repository-token', { required: true }),
     namespaceManifest: core.getInput('namespace-manifest') || undefined,
     substituteVariables: core.getMultilineInput('substitute-variables'),

bootstrap-pull-request/src/run.ts

@@ -10,6 +10,7 @@ type Inputs = {
   namespace: string
   sourceRepository: string
   destinationRepository: string
+  prebuiltBranch: string | undefined
   destinationRepositoryToken: string
   namespaceManifest: string | undefined
   substituteVariables: string[]
@@ -32,7 +33,11 @@ export const run = async (inputs: Inputs): Promise<Outputs> => {
 
 const bootstrapNamespace = async (inputs: Inputs): Promise<Outputs | Error> => {
   const [, sourceRepositoryName] = inputs.sourceRepository.split('/')
-  const prebuiltBranch = `prebuilt/${sourceRepositoryName}/${inputs.overlay}`
+  // TODO: prebuiltBranch input will be required in the future release.
+  if (inputs.prebuiltBranch === undefined) {
+    core.warning('prebuilt-branch input will be required in the future release.')
+  }
+  const prebuiltBranch = inputs.prebuiltBranch ?? `prebuilt/${sourceRepositoryName}/${inputs.overlay}`
 
   const prebuiltDirectory = await checkoutPrebuiltBranch(inputs, prebuiltBranch)
   const namespaceDirectory = await checkoutNamespaceBranch(inputs)

git-push-service/README.md

@@ -90,19 +90,19 @@ To push a manifest as a prebuilt manifest:
     manifests: ${{ steps.kustomize.outputs.directory }}/**
     overlay: pr
     service: foo
-    destination-branch: prebuilt/REPOSITORY/pr
+    destination-branch: prebuilt/source-repository/pr
 ```
 
 It pushes the following file into a destination repository:
 
 ```
-destination-repository (branch: prebuilt/${project}/${overlay})
+destination-repository (branch: prebuilt/source-repository/pr)
 └── services
     └── ${service}
         └── generated.yaml
 ```
 
-You can build the prebuilt manifest using [git-push-services-from-prebuilt action](../git-push-services-from-prebuilt).
+You can build the prebuilt manifest using [bootstrap-pull-request action](../bootstrap-pull-request).
 
 ## Options