From aad92dd26a958990cce2c660e973b63fd0406301 Mon Sep 17 00:00:00 2001 From: Max Isom Date: Fri, 13 Dec 2024 12:30:38 -0800 Subject: [PATCH] [BLD]: update deploy workflows (#3294) ## Description of changes Updates workflows for new deploy process. Depends on https://github.com/chroma-core/chroma/pull/3294. ## Test plan *How are these changes tested?* Prototyped workflows in test repositories. ## Documentation Changes *Are all docstrings for user-facing APIs updated if required? Do we need to make documentation changes in the [docs repository](https://github.com/chroma-core/docs)?* n/a --- .github/workflows/apply-hotfix.yaml | 134 ++++++++++++++++++++++++++ .github/workflows/pr.yml | 2 +- .github/workflows/trigger-deploy.yaml | 34 +++++++ 3 files changed, 169 insertions(+), 1 deletion(-) create mode 100644 .github/workflows/apply-hotfix.yaml create mode 100644 .github/workflows/trigger-deploy.yaml diff --git a/.github/workflows/apply-hotfix.yaml b/.github/workflows/apply-hotfix.yaml new file mode 100644 index 00000000000..e6f023302b6 --- /dev/null +++ b/.github/workflows/apply-hotfix.yaml @@ -0,0 +1,134 @@ +name: Apply hotfix to branch +on: + workflow_dispatch: + inputs: + pr_number: + description: 'Number of merged pull request containing the hotfix.' + required: true + branch_name: + description: 'Name of branch (release/* or rc/*) to apply hotfix to. Defaults to latest release branch.' + +jobs: + resolve-branch: + runs-on: ubuntu-latest + outputs: + branch_name: ${{ steps.resolve_branch.outputs.branch_name }} + branch_type: ${{ steps.resolve_branch.outputs.branch_type }} + steps: + - name: Check out hosted repo + uses: actions/checkout@v4 + with: + fetch-depth: 0 + + - name: Resolve branch name + id: resolve_branch + run: | + if [ "${{ github.event.inputs.branch_name }}" != "" ]; then + branch_name="${{ github.event.inputs.branch_name }}" + else + branch_name=$(git branch -r --list 'release/*' | sort -r | head -n 1 | xargs) + fi + + if [ -z "$branch_name" ]; then + echo "No release branch found." + exit 1 + fi + + branch_type=$(echo $branch_name | awk -F'[-/]' '{print $1}' ) + + echo "branch_name=$branch_name" >> $GITHUB_OUTPUT + echo "branch_type=$branch_type" >> $GITHUB_OUTPUT + + create-hotfix-pr: + runs-on: ubuntu-latest + needs: + - resolve-branch + permissions: + contents: write + pull-requests: write + steps: + - name: Checkout repository + uses: actions/checkout@v4 + with: + fetch-depth: 0 + + - name: Checkout branch + run: git checkout ${{ needs.resolve-branch.outputs.branch_name }} + + - name: Get merge commit SHA + id: get_merge_commit_sha + run: | + MERGE_COMMIT_SHA=$(gh api repos/${{ github.repository }}/pulls/${{ github.event.inputs.pr_number }} --jq '.merge_commit_sha') + echo "Merge commit SHA: $MERGE_COMMIT_SHA" + echo "MERGE_COMMIT_SHA=$MERGE_COMMIT_SHA" >> $GITHUB_OUTPUT + env: + GH_TOKEN: ${{ secrets.GITHUB_TOKEN }} + + - name: Set up Git + run: | + git config user.name "github-actions[bot]" + git config user.email "github-actions[bot]@users.noreply.github.com" + + - name: Attempt cherry-pick + run: | + BRANCH_NAME="hotfix-${{ github.event.inputs.pr_number }}/${{ needs.resolve-branch.outputs.branch_name }}" + echo "BRANCH_NAME=$BRANCH_NAME" >> $GITHUB_ENV + git checkout -b $BRANCH_NAME + + set +e + git cherry-pick ${{ steps.get_merge_commit_sha.outputs.MERGE_COMMIT_SHA }} -m 1 + status=$? + set -e + + if [ $status -eq 0 ]; then + echo "Cherry-pick succeeded." + else + echo "Cherry-pick resulted in merge conflicts. Committing conflicts as-is." + git add -A + # Commit the conflicted state as-is. This will include conflict markers in the committed files. + # The user will have to resolve them manually on the PR. + git commit -m "Cherry-pick with conflicts: ${{ steps.get_merge_commit_sha.outputs.MERGE_COMMIT_SHA }}" + fi + + - name: Push new branch + run: | + git push origin $BRANCH_NAME + + - name: Create Pull Request + uses: actions/github-script@v7 + with: + github-token: ${{ secrets.GITHUB_TOKEN }} + script: | + const baseBranch = "${{ needs.resolve-branch.outputs.branch_name }}" + const headBranch = process.env.BRANCH_NAME + const cherryCommit = "${{ steps.get_merge_commit_sha.outputs.MERGE_COMMIT_SHA }}" + const assignee = context.actor + const { data: pr } = await github.rest.pulls.create({ + owner: context.repo.owner, + repo: context.repo.repo, + title: `[HOTFIX] applying PR #${context.payload.inputs.pr_number} to ${{ needs.resolve-branch.outputs.branch_name}}`, + head: headBranch, + base: baseBranch, + body: `This PR cherry-picks the commit ${cherryCommit} onto ${{ needs.resolve-branch.outputs.branch_name }}. If there are unresolved conflicts, please resolve them manually.`, + assignees: [assignee], + requested_reviewers: [assignee], + }) + core.info(`Created PR #${pr.number}: ${pr.html_url}`) + + // Assign the PR to the user who triggered the workflow + await github.rest.issues.addAssignees({ + owner: context.repo.owner, + repo: context.repo.repo, + issue_number: pr.number, + assignees: [assignee], + }) + core.info(`Assigned PR #${pr.number} to ${assignee}`) + + // Request a review from the same user + await github.rest.pulls.requestReviewers({ + owner: context.repo.owner, + repo: context.repo.repo, + pull_number: pr.number, + reviewers: [assignee] + }) + core.info(`Requested review from ${assignee} on PR #${pr.number}`) diff --git a/.github/workflows/pr.yml b/.github/workflows/pr.yml index 9adece64ace..dade99b3462 100644 --- a/.github/workflows/pr.yml +++ b/.github/workflows/pr.yml @@ -92,7 +92,7 @@ jobs: - name: Check PR Title uses: Slashgear/action-check-pr-title@v4.3.0 with: - regexp: '\[(ENH|BUG|DOC|TST|BLD|PERF|TYP|CLN|CHORE|RELEASE)\].*' + regexp: '\[(ENH|BUG|DOC|TST|BLD|PERF|TYP|CLN|CHORE|RELEASE|HOTFIX)\].*' helpMessage: "Please tag your PR title. See https://docs.trychroma.com/contributing#contributing-code-and-ideas. You must push new code to this PR for this check to run again." - name: Comment explaining failure if: failure() diff --git a/.github/workflows/trigger-deploy.yaml b/.github/workflows/trigger-deploy.yaml new file mode 100644 index 00000000000..5b5209eecf7 --- /dev/null +++ b/.github/workflows/trigger-deploy.yaml @@ -0,0 +1,34 @@ +name: Trigger deploy +run-name: Trigger deploy from ${{ github.ref_name }} + +on: + push: + branches: + # main is not included here because it is handled by the release-chromadb.yaml workflow + - rc/** + - release/** + +jobs: + deploy: + name: Dispatch deploy workflow + runs-on: ubuntu-latest + steps: + - name: Dispatch deploy + uses: actions/github-script@v6 + with: + github-token: ${{ secrets.HOSTED_CHROMA_WORKFLOW_DISPATCH_TOKEN}} + script: | + const result = await github.rest.actions.createWorkflowDispatch({ + owner: 'chroma-core', + repo: 'hosted-chroma', + workflow_id: 'deploy.yaml', + ref: 'main', + inputs: { + 'planes': 'control,data', + environment: '${{ contains(github.ref, 'release/') && 'production' || 'staging' }}', + 'ignore-lock': true, + 'oss-ref': '${{ github.ref_name }}', + 'hosted-ref': '${{ github.ref_name }}' + } + }) + console.log(result)