Skip to content

readme triggers - #3568

Merged
Baalmart merged 4 commits into
stagingfrom
safecheck-test2
Jun 2, 2026
Merged

readme triggers#3568
Baalmart merged 4 commits into
stagingfrom
safecheck-test2

Conversation

@Psalmz777

@Psalmz777 Psalmz777 commented Jun 1, 2026

Copy link
Copy Markdown
Contributor

Summary of Changes (What does this PR do?)

  • Please include a summary of the change and which issue is fixed. Please also include relevant motivation and context. List any dependencies that are required for this change.

Status of maturity (all need to be checked before merging):

  • I've tested this locally
  • I consider this code done
  • This change ready to hit production in its current state
  • The title of the PR states what changed and the related issues number (used for the release note).
  • I've included issue number in the "Closes #ISSUE-NUMBER" part of the "What are the relevant tickets?" section to link the issue.
  • I've updated corresponding documentation for the changes in this PR.
  • I have written unit and/or e2e tests for my change(s).

How should this be manually tested?

  • Please include the steps to be done inorder to setup and test this PR.

What are the relevant tickets?

Screenshots (optional)

Summary by CodeRabbit

  • Documentation

    • Standardized heading punctuation and title formatting across READMEs for clearer, more consistent documentation.
  • Chores

    • Unified preview environment naming to produce consistent, shortened preview site names.
    • Improved preview creation and removal logic for more reliable preview builds and fewer orphaned previews.

@coderabbitai

coderabbitai Bot commented Jun 1, 2026

Copy link
Copy Markdown
Contributor

Review Change Stack

Warning

Review limit reached

@Psalmz777, we couldn't start this review because you've reached your PR review rate limit.

More reviews will be available in 49 minutes and 25 seconds. Learn how PR review limits work.

Your organization has run out of usage credits. Purchase more in the billing tab.

⌛ How to resolve this issue?

After more reviews become available, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans include higher PR review limits than trial, open-source, and free plans. In all cases, reviews become available again over time. During sustained high-volume PR review activity, CodeRabbit may temporarily slow when the next review becomes available.

Please see our Fair Usage Limits Policy for further information.

ℹ️ Review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 523446ad-01f3-4a10-a2cf-588ed64fc057

📥 Commits

Reviewing files that changed from the base of the PR and between 3243ff5 and 9dd7a6e.

📒 Files selected for processing (1)
  • .github/workflows/remove-deploy-azurepreview.yml
📝 Walkthrough

Walkthrough

Five README files had heading punctuation adjusted. GitHub Actions workflows now compute a sanitized branch-name output and all preview deployment and removal jobs use that sanitized value to construct Azure preview APP names.

Changes

README Heading Punctuation

Layer / File(s) Summary
README heading punctuation updates
src/beacon/README.md, src/docs-website/README.md, src/platform/README.md, src/vertex/README.md, src/website/README.md
Heading punctuation across five README files updated: trailing periods removed from beacon, docs-website, and website titles; trailing period added to platform "Getting Started" and vertex main title.

Azure preview workflow: sanitized branch-name

Layer / File(s) Summary
Add sanitized branch-name output
.github/workflows/deploy-frontend-azurepreview.yml, .github/workflows/remove-deploy-azurepreview.yml
Branch-name computation now exposes outputs.sanitized by truncating to 12 characters and stripping trailing dashes.
Deploy preview jobs use sanitized output
.github/workflows/deploy-frontend-azurepreview.yml (website, beacon, calibrate_app, analytics_platform, vertex, docs preview steps)
All preview deployment steps now read needs.branch-name.outputs.sanitized to set BRANCH and construct APP names, removing previous inline truncation logic.
Preview removal workflow updates
.github/workflows/remove-deploy-azurepreview.yml
Removal workflow updates: diff base for changed-files, refactored file-category checks, and all preview-removal jobs now use needs.branch-name.outputs.sanitized to build ${BRANCH}-<service>-preview names.

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~20 minutes

Possibly related PRs

Suggested reviewers

  • Baalmart

Poem

📝 A period trimmed, a period placed,
README lines set, punctuation traced.
Branch names shortened, dashes shed,
Previews roll out from names well-led.
Tiny fixes, tidy thread.

🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 inconclusive)

Check name Status Explanation Resolution
Title check ❓ Inconclusive The title "readme triggers" is vague and generic, using non-descriptive terms that don't convey meaningful information about the changeset's primary modifications. Clarify the title to reflect the actual changes: consider "Standardize README heading punctuation and improve branch-name sanitization workflow" or similar to capture both the documentation and workflow updates.
✅ Passed checks (4 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch safecheck-test2

Warning

Review ran into problems

🔥 Problems

Errors were encountered while retrieving linked issues.

Errors (1)
  • JIRA integration encountered authorization issues. Please disconnect and reconnect the integration in the CodeRabbit UI.

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

@github-actions

github-actions Bot commented Jun 1, 2026

Copy link
Copy Markdown
Contributor

New azure website changes available for preview here

@github-actions

github-actions Bot commented Jun 1, 2026

Copy link
Copy Markdown
Contributor

New azure docs changes available for preview here

@github-actions

github-actions Bot commented Jun 1, 2026

Copy link
Copy Markdown
Contributor

New azure analytics_platform changes available for preview here

@github-actions

github-actions Bot commented Jun 1, 2026

Copy link
Copy Markdown
Contributor

New azure vertex changes available for preview here

@github-actions

github-actions Bot commented Jun 1, 2026

Copy link
Copy Markdown
Contributor

New azure beacon changes available for preview here

@github-actions

github-actions Bot commented Jun 2, 2026

Copy link
Copy Markdown
Contributor

New azure website changes available for preview here

@github-actions

github-actions Bot commented Jun 2, 2026

Copy link
Copy Markdown
Contributor

New azure docs changes available for preview here

@github-actions

github-actions Bot commented Jun 2, 2026

Copy link
Copy Markdown
Contributor

New azure analytics_platform changes available for preview here

@github-actions

github-actions Bot commented Jun 2, 2026

Copy link
Copy Markdown
Contributor

New azure vertex changes available for preview here

@github-actions

github-actions Bot commented Jun 2, 2026

Copy link
Copy Markdown
Contributor

New azure beacon changes available for preview here

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 2

🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In @.github/workflows/deploy-frontend-azurepreview.yml:
- Around line 25-38: The cleanup workflows still compute the app-name from the
raw lowercase branch substring (e.g., `${BRANCH:0:12}` / `lowercase`) causing
mismatched names when the 12-char prefix ends with '-' — update all
remove-*-preview jobs to use the same sanitized value used by deploy (the
`sanitize` step output, e.g., `${{ steps.sanitize.outputs.sanitized }}`) when
constructing the app name (replace `${BRANCH:0:12}-<service>-preview` or uses of
`lowercase` with the sanitized output) so deletion targets the exact names
created by the deploy workflow.
- Around line 33-38: The sanitize step currently injects untrusted
branch-derived text directly into a shell expression (using RAW="${{
steps.string.outputs.lowercase }}"), which risks shell-injection; change the
sanitize job to pass the lowercase value via env: (e.g., env: RAW: ${{
steps.string.outputs.lowercase }}) and use a safe, non-evaluating command such
as printf '%s' "$RAW" | cut -c1-12 | sed 's/-*$//' to produce CLEAN, then write
the output to GITHUB_OUTPUT using a quoted echo/printf (e.g., printf
"sanitized=%s\n" "$CLEAN" >> "$GITHUB_OUTPUT") to avoid
word-splitting/evaluation. Also ensure cleanup uses the same normalized output
symbol needs.branch-name.outputs.sanitized (not
needs.branch-name.outputs.lowercase) and applies the identical truncation/trim
logic so preview app names match between deploy and remove steps.
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 77f7c4fb-942f-40ca-bef2-1efc59cc6eb0

📥 Commits

Reviewing files that changed from the base of the PR and between 77786bc and 5f7dedb.

📒 Files selected for processing (1)
  • .github/workflows/deploy-frontend-azurepreview.yml

Comment thread .github/workflows/deploy-frontend-azurepreview.yml Outdated
Comment thread .github/workflows/deploy-frontend-azurepreview.yml Outdated
@github-actions

github-actions Bot commented Jun 2, 2026

Copy link
Copy Markdown
Contributor

New azure docs changes available for preview here

@github-actions

github-actions Bot commented Jun 2, 2026

Copy link
Copy Markdown
Contributor

New azure website changes available for preview here

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 2

🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In @.github/workflows/deploy-frontend-azurepreview.yml:
- Line 29: Replace the unpinned action reference "uses:
ASzc/change-string-case-action@v5" with the commit-pinned reference using the v5
tag’s SHA so the workflow is pinned to a specific commit; update the uses line
to "ASzc/change-string-case-action@07c1e24a97f0951e13f88870b99c058fcf0b14cf"
(keep the same action name but swap the tag for the given SHA).

In @.github/workflows/remove-deploy-azurepreview.yml:
- Around line 22-33: The workflow uses ASzc/change-string-case-action@v2 while
the deploy workflow uses `@v5`, which can cause differing sanitized branch names;
update the "uses" entry for the string-case action in this file to the exact
same version (or pinned commit hash) as the deploy workflow (replace
ASzc/change-string-case-action@v2 with the same `@v5` or commit ref), then verify
the sanitize step that reads env RAW and computes CLEAN remains compatible so
both workflows produce identical sanitized values.
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 24eb219e-e277-487e-8ba4-3fdd66d724be

📥 Commits

Reviewing files that changed from the base of the PR and between 5f7dedb and 3243ff5.

📒 Files selected for processing (2)
  • .github/workflows/deploy-frontend-azurepreview.yml
  • .github/workflows/remove-deploy-azurepreview.yml


steps:
- id: string
uses: ASzc/change-string-case-action@v5

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🟡 Minor | ⚡ Quick win

🧩 Analysis chain

🏁 Script executed:

#!/bin/bash
# Fetch the current commit SHA for ASzc/change-string-case-action v5
gh api repos/ASzc/change-string-case-action/git/ref/tags/v5 --jq '.object.sha' 2>/dev/null || echo "Could not resolve tag"

Repository: airqo-platform/AirQo-frontend

Length of output: 114


🏁 Script executed:

#!/bin/bash
set -euo pipefail

FILE=".github/workflows/deploy-frontend-azurepreview.yml"

echo "---- File head (first 120 lines) ----"
nl -ba "$FILE" | sed -n '1,120p'

echo "---- Lines around 29 ----"
nl -ba "$FILE" | sed -n '20,45p'

echo "---- Extract on: section (quick) ----"
awk 'BEGIN{in_on=0}
     /^(on:|on )/{in_on=1}
     in_on{print}
     /^[^ ]/ && in_on && $0 !~ /^on:/ {exit}' "$FILE" || true

Repository: airqo-platform/AirQo-frontend

Length of output: 172


🏁 Script executed:

#!/bin/bash
set -euo pipefail

FILE=".github/workflows/deploy-frontend-azurepreview.yml"
echo "== sanity: file = $FILE =="
ls -la "$FILE" || true
echo "== first 140 lines =="
cat -n "$FILE" | sed -n '1,140p'
echo "== around uses line (lines 20-60) =="
cat -n "$FILE" | sed -n '20,60p'
echo "== grep for pull_request_target / pull_request =="
rg -n "pull_request_target|pull_request" "$FILE" || true

Repository: airqo-platform/AirQo-frontend

Length of output: 8930


Pin ASzc/change-string-case-action to a commit SHA for supply-chain security.

This workflow runs on pull_request_target and currently uses ASzc/change-string-case-action@v5 (line 29). Pin it to the v5 tag’s commit SHA: 07c1e24a97f0951e13f88870b99c058fcf0b14cf.

Example pin format
        - id: string
-          uses: ASzc/change-string-case-action@v5
+          uses: ASzc/change-string-case-action@07c1e24a97f0951e13f88870b99c058fcf0b14cf  # v5
          with:
            string: ${{ github.head_ref || github.ref_name }}
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
uses: ASzc/change-string-case-action@v5
- id: string
uses: ASzc/change-string-case-action@07c1e24a97f0951e13f88870b99c058fcf0b14cf # v5
with:
string: ${{ github.head_ref || github.ref_name }}
🧰 Tools
🪛 zizmor (1.25.2)

[error] 29-29: unpinned action reference (unpinned-uses): action is not pinned to a hash (required by blanket policy)

(unpinned-uses)

🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In @.github/workflows/deploy-frontend-azurepreview.yml at line 29, Replace the
unpinned action reference "uses: ASzc/change-string-case-action@v5" with the
commit-pinned reference using the v5 tag’s SHA so the workflow is pinned to a
specific commit; update the uses line to
"ASzc/change-string-case-action@07c1e24a97f0951e13f88870b99c058fcf0b14cf" (keep
the same action name but swap the tag for the given SHA).

Comment thread .github/workflows/remove-deploy-azurepreview.yml
@github-actions

github-actions Bot commented Jun 2, 2026

Copy link
Copy Markdown
Contributor

New azure analytics_platform changes available for preview here

@github-actions

github-actions Bot commented Jun 2, 2026

Copy link
Copy Markdown
Contributor

New azure vertex changes available for preview here

@github-actions

github-actions Bot commented Jun 2, 2026

Copy link
Copy Markdown
Contributor

New azure beacon changes available for preview here

@github-actions

github-actions Bot commented Jun 2, 2026

Copy link
Copy Markdown
Contributor

New azure website changes available for preview here

@github-actions

github-actions Bot commented Jun 2, 2026

Copy link
Copy Markdown
Contributor

New azure docs changes available for preview here

@github-actions

github-actions Bot commented Jun 2, 2026

Copy link
Copy Markdown
Contributor

New azure analytics_platform changes available for preview here

@github-actions

github-actions Bot commented Jun 2, 2026

Copy link
Copy Markdown
Contributor

New azure vertex changes available for preview here

@github-actions

github-actions Bot commented Jun 2, 2026

Copy link
Copy Markdown
Contributor

New azure beacon changes available for preview here

@Baalmart
Baalmart merged commit 60a6107 into staging Jun 2, 2026
27 of 28 checks passed
@Baalmart
Baalmart deleted the safecheck-test2 branch June 2, 2026 09:02
@Baalmart Baalmart mentioned this pull request Jun 2, 2026
5 tasks
This was referenced Jun 3, 2026
@coderabbitai coderabbitai Bot mentioned this pull request Jul 1, 2026
7 tasks
@coderabbitai coderabbitai Bot mentioned this pull request Jul 11, 2026
7 tasks
@coderabbitai coderabbitai Bot mentioned this pull request Jul 20, 2026
7 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants