-
Notifications
You must be signed in to change notification settings - Fork 976
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge branch 'current' into mirnawong1-patch-26
- Loading branch information
Showing
36 changed files
with
672 additions
and
274 deletions.
There are no files selected for viewing
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,169 @@ | ||
| name: Vercel deployment preview link generator | ||
|
|
||
| on: | ||
| pull_request: | ||
| types: [opened, synchronize] | ||
| paths: | ||
| - 'website/docs/docs/**' | ||
| - 'website/docs/best-practices/**' | ||
| - 'website/docs/guides/**' | ||
| - 'website/docs/faqs/**' | ||
| - 'website/docs/reference/**' | ||
|
|
||
| permissions: | ||
| contents: write | ||
| pull-requests: write | ||
|
|
||
| jobs: | ||
| update-pr-description: | ||
| runs-on: ubuntu-latest | ||
|
|
||
| steps: | ||
| - name: Checkout code | ||
| uses: actions/checkout@v4 | ||
| with: | ||
| fetch-depth: 0 | ||
|
|
||
| - name: Install necessary tools | ||
| run: | | ||
| sudo apt-get update | ||
| sudo apt-get install -y jq curl | ||
| - name: Generate Vercel deployment URL | ||
| id: vercel_url | ||
| run: | | ||
| # Get the branch name | ||
| BRANCH_NAME="${{ github.head_ref }}" | ||
| # Convert to lowercase | ||
| BRANCH_NAME_LOWER=$(echo "$BRANCH_NAME" | tr '[:upper:]' '[:lower:]') | ||
| # Replace non-alphanumeric characters with hyphens | ||
| BRANCH_NAME_SANITIZED=$(echo "$BRANCH_NAME_LOWER" | sed 's/[^a-z0-9]/-/g') | ||
| # Construct the deployment URL | ||
| DEPLOYMENT_URL="https://docs-getdbt-com-git-${BRANCH_NAME_SANITIZED}-dbt-labs.vercel.app" | ||
| echo "deployment_url=$DEPLOYMENT_URL" >> $GITHUB_OUTPUT | ||
| - name: Wait for deployment to be accessible | ||
| id: wait_for_deployment | ||
| run: | | ||
| DEPLOYMENT_URL="${{ steps.vercel_url.outputs.deployment_url }}" | ||
| echo "Waiting for deployment at $DEPLOYMENT_URL to become accessible..." | ||
| MAX_ATTEMPTS=60 # Wait up to 10 minutes | ||
| SLEEP_TIME=10 # Check every 10 seconds | ||
| ATTEMPTS=0 | ||
| while [ $ATTEMPTS -lt $MAX_ATTEMPTS ]; do | ||
| STATUS_CODE=$(curl -s -o /dev/null -w "%{http_code}" "$DEPLOYMENT_URL") | ||
| if [ "$STATUS_CODE" -eq 200 ]; then | ||
| echo "Deployment is accessible." | ||
| break | ||
| else | ||
| echo "Deployment not yet accessible (status code: $STATUS_CODE). Waiting..." | ||
| sleep $SLEEP_TIME | ||
| ATTEMPTS=$((ATTEMPTS + 1)) | ||
| fi | ||
| done | ||
| if [ $ATTEMPTS -eq $MAX_ATTEMPTS ]; then | ||
| echo "Deployment did not become accessible within the expected time." | ||
| exit 1 | ||
| fi | ||
| - name: Get changed files | ||
| id: files | ||
| run: | | ||
| CHANGED_FILES=$(git diff --name-only ${{ github.event.pull_request.base.sha }} ${{ github.sha }} | grep -E '^website/docs/(docs|best-practices|guides|faqs|reference)/.*\.md$' || true) | ||
| if [ -z "$CHANGED_FILES" ]; then | ||
| echo "No documentation files were changed." | ||
| echo "changed_files=" >> $GITHUB_OUTPUT | ||
| else | ||
| CHANGED_FILES=$(echo "$CHANGED_FILES" | tr '\n' ' ') | ||
| echo "changed_files=$CHANGED_FILES" >> $GITHUB_OUTPUT | ||
| fi | ||
| - name: Generate file preview links | ||
| id: links | ||
| run: | | ||
| DEPLOYMENT_URL="${{ steps.vercel_url.outputs.deployment_url }}" | ||
| CHANGED_FILES="${{ steps.files.outputs.changed_files }}" | ||
| if [ -z "$CHANGED_FILES" ]; then | ||
| echo "No changed files found in the specified directories." | ||
| LINKS="No documentation files were changed." | ||
| else | ||
| LINKS="" | ||
| # Convert CHANGED_FILES back to newline-separated for processing | ||
| CHANGED_FILES=$(echo "$CHANGED_FILES" | tr ' ' '\n') | ||
| for FILE in $CHANGED_FILES; do | ||
| # Remove 'website/docs/' prefix | ||
| FILE_PATH="${FILE#website/docs/}" | ||
| # Remove the .md extension | ||
| FILE_PATH="${FILE_PATH%.md}" | ||
| # Construct the full URL | ||
| FULL_URL="$DEPLOYMENT_URL/$FILE_PATH" | ||
| LINKS="$LINKS\n- $FULL_URL" | ||
| done | ||
| fi | ||
| # Properly set the multi-line output | ||
| echo "links<<EOF" >> $GITHUB_OUTPUT | ||
| echo -e "$LINKS" >> $GITHUB_OUTPUT | ||
| echo "EOF" >> $GITHUB_OUTPUT | ||
| - name: Update PR description with deployment links | ||
| uses: actions/github-script@v6 | ||
| with: | ||
| github-token: ${{ secrets.GITHUB_TOKEN }} | ||
| script: | | ||
| const prNumber = context.issue.number; | ||
| // Fetch the current PR description | ||
| const { data: pullRequest } = await github.rest.pulls.get({ | ||
| owner: context.repo.owner, | ||
| repo: context.repo.repo, | ||
| pull_number: prNumber, | ||
| }); | ||
| let body = pullRequest.body || ''; | ||
| // Define the markers | ||
| const startMarker = '<!-- vercel-deployment-preview -->'; | ||
| const endMarker = '<!-- end-vercel-deployment-preview -->'; | ||
| // Get the deployment URL and links from environment variables | ||
| const deploymentUrl = process.env.DEPLOYMENT_URL; | ||
| const links = process.env.LINKS; | ||
| // Build the deployment content without leading whitespace | ||
| const deploymentContent = [ | ||
| `${startMarker}`, | ||
| '---', | ||
| '🚀 Deployment available! Here are the direct links to the updated files:', | ||
| '', | ||
| `${links}`, | ||
| '', | ||
| `${endMarker}` | ||
| ].join('\n'); | ||
| // Remove existing deployment content between markers | ||
| const regex = new RegExp(`${startMarker}[\\s\\S]*?${endMarker}`, 'g'); | ||
| body = body.replace(regex, '').trim(); | ||
| // Append the new deployment content | ||
| body = `${body}\n\n${deploymentContent}`; | ||
| // Update the PR description | ||
| await github.rest.pulls.update({ | ||
| owner: context.repo.owner, | ||
| repo: context.repo.repo, | ||
| pull_number: prNumber, | ||
| body: body, | ||
| }); | ||
| env: | ||
| DEPLOYMENT_URL: ${{ steps.vercel_url.outputs.deployment_url }} | ||
| LINKS: ${{ steps.links.outputs.links }} |
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,80 @@ | ||
| name: Vale linting | ||
|
|
||
| on: | ||
| pull_request: | ||
| types: [opened, synchronize, reopened] | ||
| paths: | ||
| - 'website/docs/**/*' | ||
| - 'website/blog/**/*' | ||
| - 'website/**/*' | ||
|
|
||
| jobs: | ||
| vale: | ||
| name: Vale linting | ||
| runs-on: ubuntu-latest | ||
| steps: | ||
| - name: Checkout code | ||
| uses: actions/checkout@v3 | ||
| with: | ||
| fetch-depth: 1 | ||
|
|
||
| - name: List repository contents | ||
| run: | | ||
| pwd | ||
| ls -R | ||
| - name: Set up Python | ||
| uses: actions/setup-python@v5 | ||
| with: | ||
| python-version: '3.x' | ||
|
|
||
| - name: Install Vale | ||
| run: pip install vale==2.27.0 # Install a stable version of Vale | ||
|
|
||
| - name: Get changed files | ||
| id: changed-files | ||
| uses: tj-actions/changed-files@v34 | ||
| with: | ||
| files: | | ||
| website/**/*.md | ||
| separator: ' ' | ||
|
|
||
| - name: Debugging - Print changed files | ||
| if: ${{ steps.changed-files.outputs.any_changed == 'true' }} | ||
| run: | | ||
| echo "Changed files:" | ||
| echo "${{ steps.changed-files.outputs.all_changed_and_modified_files }}" | ||
| - name: Confirm files exist | ||
| if: ${{ steps.changed-files.outputs.any_changed == 'true' }} | ||
| run: | | ||
| echo "Checking if files exist..." | ||
| for file in ${{ steps.changed-files.outputs.all_changed_and_modified_files }}; do | ||
| if [ -f "$file" ]; then | ||
| echo "Found: $file" | ||
| else | ||
| echo "File not found: $file" | ||
| exit 1 | ||
| fi | ||
| done | ||
| - name: Run vale | ||
| if: ${{ steps.changed-files.outputs.any_changed == 'true' }} | ||
| uses: errata-ai/vale-action@reviewdog | ||
| with: | ||
| token: ${{ secrets.GITHUB_TOKEN }} | ||
| reporter: github-check | ||
| files: ${{ steps.changed-files.outputs.all_changed_and_modified_files }} | ||
| separator: ' ' | ||
| version: '2.27.0' | ||
|
|
||
| # - name: Post summary comment | ||
| # if: ${{ steps.changed-files.outputs.any_changed == 'true' }} | ||
| # run: | | ||
| # COMMENT="❗️Oh no, some Vale linting found issues! Please check the **Files change** tab for detailed results and make the necessary updates." | ||
| # COMMENT+=$'\n' | ||
| # COMMENT+=$'\n\n' | ||
| # COMMENT+="➡️ Link to detailed report: [Files changed](${{ github.event.pull_request.html_url }}/files)" | ||
| # gh pr comment ${{ github.event.pull_request.number }} --body "$COMMENT" | ||
| # env: | ||
| # GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} |
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,10 @@ | ||
| content_dir: /docs | ||
| authorized_users: | ||
| - mirnawong1 | ||
| - matthewshaver | ||
| - nghi-ly | ||
| - runleonarun | ||
| - nataliefiann | ||
|
|
||
| vale: | ||
| enabled: true |
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,7 @@ | ||
| StylesPath = styles | ||
| MinAlertLevel = warning | ||
|
|
||
| Vocab = EN | ||
|
|
||
| [*.md] | ||
| BasedOnStyles = custom |
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
Oops, something went wrong.