db: Re-order migrations for next release #720
Workflow file for this run
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| name: schema-diff | |
| on: | |
| pull_request: | |
| types: | |
| # By default, a workflow only runs when a pull_request event's activity | |
| # type is `opened`, `synchronize`, or `reopened`. | |
| # https://docs.github.com/en/actions/using-workflows/events-that-trigger-workflows#pull_request | |
| # Since we care about the PR state, we also need to run when there is a PR | |
| # state change: From "Draft" to "Ready for Review" and vice-versa. | |
| - 'opened' | |
| - 'synchronize' | |
| - 'reopened' | |
| - 'converted_to_draft' | |
| - 'ready_for_review' | |
| paths: | |
| - 'internal/db/schema/migrations/**/*.sql' | |
| - 'scripts/schema-diff.sh' | |
| - '.github/scripts/schema-diff-hide-gh-comments.sh' | |
| - '.github/workflows/schema-diff.yml' | |
| permissions: | |
| contents: read | |
| issues: write | |
| pull-requests: write | |
| jobs: | |
| schema-diff: | |
| name: "Schema Diff" | |
| if: '! github.event.pull_request.draft' | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@692973e3d937129bcbf40652eb9f2f61becf3332 # v4.1.7 | |
| with: | |
| fetch-depth: '0' | |
| - name: Generate Schema Diff | |
| env: | |
| PGPASSWORD: boundary | |
| run: | | |
| # Run schema-diff between the code in the PR and its base. | |
| ./scripts/schema-diff.sh "origin/${GITHUB_BASE_REF}" | |
| gh_comment_prefix='Database schema diff between' | |
| gh_user_login='github-actions[bot]' | |
| # Hide previous schema-diff comments we've posted. | |
| echo 'Hiding previous PR comments' | |
| ./.github/scripts/schema-diff-hide-gh-comments.sh \ | |
| "$GITHUB_API_URL" \ | |
| "$GITHUB_GRAPHQL_URL" \ | |
| "${{ secrets.GITHUB_TOKEN }}" \ | |
| "$GITHUB_REPOSITORY" \ | |
| "${{ github.event.pull_request.number }}" \ | |
| "$gh_comment_prefix" \ | |
| "$gh_user_login" | |
| # getdiff echoes the diff in GitHub markdown syntax or "Unchanged" if | |
| # the file is empty. | |
| getdiff() { | |
| if [[ -s "$1" ]]; then | |
| echo \`\`\`diff | |
| cat "$1" | |
| echo \`\`\` | |
| else | |
| echo "Unchanged" | |
| fi | |
| } | |
| # Build heredoc with all the diffs the schema diff tool generated. | |
| echo 'Building new GitHub schema-diff comment' | |
| cat << EOF > github-comment.txt | |
| $gh_comment_prefix \`${GITHUB_BASE_REF}\` and \`${GITHUB_HEAD_REF}\` @ ${{ github.event.pull_request.head.sha }} | |
| To understand how these diffs are generated and some limitations see the | |
| [documentation](https://github.com/hashicorp/boundary/blob/main/scripts/schema-diff.sh) of the script. | |
| #### Functions | |
| $(getdiff .schema-diff/funcs.diff) | |
| #### Tables | |
| $(getdiff .schema-diff/tables.diff) | |
| #### Views | |
| $(getdiff .schema-diff/views.diff) | |
| #### Triggers | |
| $(getdiff .schema-diff/triggers.diff) | |
| #### Indexes | |
| $(getdiff .schema-diff/indexes.diff) | |
| #### Constraints | |
| $(getdiff .schema-diff/constraints.diff) | |
| #### Foreign Key Constraints | |
| $(getdiff .schema-diff/fk_constraints.diff) | |
| EOF | |
| # Parse it through jq to build a valid json object. | |
| jq --null-input \ | |
| --rawfile comment github-comment.txt \ | |
| '{"body": $comment}' > body.json | |
| # Post comment on PR. | |
| echo "Posting new GitHub schema-diff comment under PR #${{ github.event.pull_request.number }}" | |
| curl -sX POST \ | |
| -H "Accept: application/vnd.github+json" \ | |
| -H "Authorization: Bearer ${{ secrets.GITHUB_TOKEN }}" \ | |
| -d @body.json \ | |
| "$GITHUB_API_URL/repos/$GITHUB_REPOSITORY/issues/${{ github.event.pull_request.number }}/comments" |