Skip to content

Conversation

@igorpecovnik
Copy link
Member

@igorpecovnik igorpecovnik commented Dec 25, 2025

Summary

Standardize all GitHub Actions workflow names to be more logical, consistent, and action-oriented.

Changes

Workflow Naming Convention

  • Use action verb first (in lowercase)
  • Keep names concise and descriptive
  • Remove unnecessary words and details

Renamed Workflows (20 total)

Old Name New Name
Kernel Hardening Analysis Analyze kernel security
Announce PR merge to Discord Announce merge
Announce PR on Discord for review Announce PR
Automatic Pull Request Labeling Auto-label PR
Generate Artifacts on PR if... Build PR artifacts
Check new board assets exist... Check PR assets
Clean Workflow Logs Clean workflow logs
Jira Sync Sync Jira
Forked Helper Help forks
PR review labeler Label PR on approval
Lint on Scripts Lint scripts
PR review listener Listen PR review
Rewrite kernel configs Rewrite kernel configs
Scorecards Security Scan Scan security
Update Board Lists Sync board list
Sync Labels from YAML Sync labels
Sync maintainers status Sync maintainers
Update Tools in Scripts Sync tools
Welcome first-time issue contributor Welcome first-time contributor

Additional Fixes

  • Updated internal reference in rewrite-kernel-config-files.yml PR body to use new filename

Summary by CodeRabbit

Chores

  • Standardized GitHub Actions workflow names for improved clarity and consistency across multiple CI/CD pipelines in the project.

✏️ Tip: You can customize this high-level summary in your review settings.

Make all workflow names consistent and action-oriented:
- Use action verb first (Announce, Auto-label, Build, Check, Clean, Help, Label, Lint, Listen, Rewrite, Scan, Sync, Welcome)
- Keep names concise and descriptive
- Remove unnecessary details from the name

Changes:
- Analyze kernel security (was: Kernel Hardening Analysis)
- Announce merge (was: Announce PR merge to Discord)
- Announce PR (was: Announce PR on Discord for review)
- Auto-label PR (was: Automatic Pull Request Labeling)
- Build PR artifacts (was: Generate Artifacts on PR if...)
- Check PR assets (was: Check new board assets exist...)
- Clean workflow logs (was: Clean Workflow Logs)
- Sync Jira (was: Jira Sync)
- Help forks (was: Forked Helper)
- Label PR on approval (was: PR review labeler)
- Lint scripts (was: Lint on Scripts)
- Listen PR review (was: PR review listener)
- Rewrite kernel configs (was: Rewrite kernel configs - same)
- Scan security (was: Scorecards Security Scan)
- Sync board list (was: Update Board Lists)
- Sync labels (was: Sync Labels from YAML)
- Sync maintainers (was: Sync maintainers status)
- Sync tools (was: Update Tools in Scripts)
- Welcome first-time contributor (was: Welcome first-time issue contributor)
- Welcome first-time PR contributor (was: same - kept as is)
@coderabbitai
Copy link
Contributor

coderabbitai bot commented Dec 25, 2025

📝 Walkthrough

Walkthrough

This PR systematically renames multiple GitHub Actions workflows for consistency and clarity, updating display names and run-name references across 21 workflow files. Minor formatting adjustments to workflow metadata are applied alongside the renamings.

Changes

Cohort / File(s) Summary
Workflow Name Simplifications
auto-label-pr.yml, check-pr-pictures.yml, cleanup-workflow-logs.yml, help-forked.yml, lint-pr-scripts.yml, sync-board-list.yml, sync-labels.yml, sync-tools.yml, welcome-pr-first-time.yml
Renamed workflow display names for brevity and consistency (e.g., "Automatic Pull Request Labeling" → "Auto-label PR"). No functional changes.
Workflow Names with Run-name Updates
analyze-pr-kernel-security.yml, build-pr-artifacts.yml
Updated workflow name and corresponding run-name strings to reflect PR metadata (number, title, or actor). No control flow changes.
Workflow Name Changes
announce-merge.yml, announce-pr.yml, create-jira-ticket.yml, listen-pr-review.yml, scorecard.yml, sync-maintainers-status.yml, welcome-issue-first-time.yml
Renamed workflow display names (e.g., "Announce PR merge to Discord" → "Announce merge"). YAML quoting style adjusted in some cases. No behavioral changes.
Workflow with New Trigger Condition
label-pr-on-approval.yml
Renamed workflow and added workflow_run.types: [completed] trigger to fire on upstream workflow completion. Expands workflow triggering logic.
Workflow with Path Reference Update
rewrite-kernel-config-files.yml
Renamed workflow name (removed quotes) and updated internal workflow path reference from rewrite-kernel-configs.yml to rewrite-kernel-config-files.yml.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Possibly related PRs

Suggested reviewers

  • rpardini
  • hzyitc

Poem

🐰 Twenty-one workflows dressed in brand new names,
Simpler, clearer—no longer quite the same!
From "Kernel Hardening" to "Scan security"—
Each label trimmed with such dignity.

Pre-merge checks and finishing touches

✅ Passed checks (3 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The pull request title 'chore: standardize workflow names' accurately summarizes the main change: renaming 20 GitHub Actions workflows to follow a consistent naming convention.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
✨ Finishing touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch chore/rename-workflow-files

📜 Recent review details

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

Disabled knowledge base sources:

  • Jira integration is disabled by default for public repositories

You can enable these sources in your CodeRabbit configuration.

📥 Commits

Reviewing files that changed from the base of the PR and between f56bfc7 and 43f6975.

📒 Files selected for processing (20)
  • .github/workflows/analyze-pr-kernel-security.yml
  • .github/workflows/announce-merge.yml
  • .github/workflows/announce-pr.yml
  • .github/workflows/auto-label-pr.yml
  • .github/workflows/build-pr-artifacts.yml
  • .github/workflows/check-pr-pictures.yml
  • .github/workflows/cleanup-workflow-logs.yml
  • .github/workflows/create-jira-ticket.yml
  • .github/workflows/help-forked.yml
  • .github/workflows/label-pr-on-approval.yml
  • .github/workflows/lint-pr-scripts.yml
  • .github/workflows/listen-pr-review.yml
  • .github/workflows/rewrite-kernel-config-files.yml
  • .github/workflows/scorecard.yml
  • .github/workflows/sync-board-list.yml
  • .github/workflows/sync-labels.yml
  • .github/workflows/sync-maintainers-status.yml
  • .github/workflows/sync-tools.yml
  • .github/workflows/welcome-issue-first-time.yml
  • .github/workflows/welcome-pr-first-time.yml
🧰 Additional context used
🧠 Learnings (13)
📓 Common learnings
Learnt from: igorpecovnik
Repo: armbian/build PR: 8705
File: .github/workflows/rewrite-kernel-configs.yml:96-169
Timestamp: 2025-10-03T11:42:46.660Z
Learning: In the Armbian build repository's kernel config rewrite workflow (.github/workflows/rewrite-kernel-configs.yml), deletion of kernel config files does not need to be handled. The workflow intentionally only captures ACMR (added/copied/modified/renamed) changes and does not need to propagate deletions to the aggregator.
Learnt from: igorpecovnik
Repo: armbian/build PR: 9087
File: .github/workflows/pr-check-pictures.yml:138-146
Timestamp: 2025-12-16T13:40:07.649Z
Learning: In the Armbian build repository, when introducing new requirements or checks (like the board assets verification workflow), the project prefers an initial educational-only period where violations post helpful PR comments and warnings but don't block merges. This allows contributors to become familiar with new requirements before enforcement is enabled (typically after ~6 months).
📚 Learning: 2025-12-16T13:40:07.649Z
Learnt from: igorpecovnik
Repo: armbian/build PR: 9087
File: .github/workflows/pr-check-pictures.yml:138-146
Timestamp: 2025-12-16T13:40:07.649Z
Learning: In the Armbian build repository, when introducing new requirements or checks (like the board assets verification workflow), the project prefers an initial educational-only period where violations post helpful PR comments and warnings but don't block merges. This allows contributors to become familiar with new requirements before enforcement is enabled (typically after ~6 months).

Applied to files:

  • .github/workflows/check-pr-pictures.yml
📚 Learning: 2025-10-03T11:42:46.660Z
Learnt from: igorpecovnik
Repo: armbian/build PR: 8705
File: .github/workflows/rewrite-kernel-configs.yml:96-169
Timestamp: 2025-10-03T11:42:46.660Z
Learning: In the Armbian build repository's kernel config rewrite workflow (.github/workflows/rewrite-kernel-configs.yml), deletion of kernel config files does not need to be handled. The workflow intentionally only captures ACMR (added/copied/modified/renamed) changes and does not need to propagate deletions to the aggregator.

Applied to files:

  • .github/workflows/rewrite-kernel-config-files.yml
  • .github/workflows/sync-board-list.yml
📚 Learning: 2025-10-04T17:59:19.369Z
Learnt from: igorpecovnik
Repo: armbian/build PR: 8705
File: .github/workflows/rewrite-kernel-configs.yml:217-220
Timestamp: 2025-10-04T17:59:19.369Z
Learning: In the Armbian build repository's kernel config rewrite workflow (.github/workflows/rewrite-kernel-configs.yml), the workflow is designed to rewrite existing kernel configs only. New/untracked files can be safely ignored, so using `git diff --quiet` (which ignores untracked files) is the correct approach for detecting changes rather than `git status --porcelain`.

Applied to files:

  • .github/workflows/rewrite-kernel-config-files.yml
📚 Learning: 2025-11-20T18:20:11.985Z
Learnt from: EvilOlaf
Repo: armbian/build PR: 8968
File: patch/u-boot/u-boot-sunxi/arm64-dts-sun50i-h6-orangepi.dtsi-Rollback-r_rsb-to-r_i2c.patch:36-36
Timestamp: 2025-11-20T18:20:11.985Z
Learning: The rewrite-patches tool (REWRITE_PATCHES=yes) in the Armbian build system can inadvertently introduce semantic changes when the u-boot/kernel git base revision differs from expected state. The tool applies patches, commits them, and re-exports them using git format-patch, which can cause the re-exported patch to reflect the base revision's state rather than preserving the original patch intent. This is particularly problematic for device tree changes like interrupt specifications. The tool currently lacks validation mechanisms to detect such semantic drift, and affected patches must be manually corrected after rewriting.

Applied to files:

  • .github/workflows/rewrite-kernel-config-files.yml
📚 Learning: 2025-09-27T21:50:04.845Z
Learnt from: tabrisnet
Repo: armbian/build PR: 8678
File: config/kernel/linux-sm8250-edge.config:80-82
Timestamp: 2025-09-27T21:50:04.845Z
Learning: In the Armbian build system, kernel configuration files are generated through this automated process: taking previous config → applying scripted changes from armbian-kernel.sh → running kernel's `make oldconfig` → processing by Armbian machinery back into config files. This automated process properly handles kernel configuration dependencies and reduces the likelihood of manual configuration errors.

Applied to files:

  • .github/workflows/rewrite-kernel-config-files.yml
📚 Learning: 2025-09-27T21:47:58.020Z
Learnt from: tabrisnet
Repo: armbian/build PR: 8678
File: config/kernel/linux-bcm2711-edge.config:859-861
Timestamp: 2025-09-27T21:47:58.020Z
Learning: In the Armbian build system, kernel configuration files in config/kernel/ are generated through an automated process: taking previous config → applying scripted changes from armbian-kernel.sh → running kernel's `make oldconfig` → processing by Armbian machinery back into config files. This automated process properly handles kernel configuration dependencies and reduces the likelihood of manual configuration errors.

Applied to files:

  • .github/workflows/rewrite-kernel-config-files.yml
📚 Learning: 2025-09-27T21:50:15.915Z
Learnt from: tabrisnet
Repo: armbian/build PR: 8678
File: config/kernel/linux-sunxi64-current.config:94-94
Timestamp: 2025-09-27T21:50:15.915Z
Learning: When kernel config files are generated through Armbian's automated process (previous config → armbian-kernel.sh changes → make oldconfig → Armbian machinery processing), manual config file edits are not appropriate since they would be overwritten. Deprecated option handling should be implemented in the automated tooling instead.

Applied to files:

  • .github/workflows/rewrite-kernel-config-files.yml
📚 Learning: 2025-09-27T21:49:55.796Z
Learnt from: tabrisnet
Repo: armbian/build PR: 8678
File: config/kernel/linux-sm8250-current.config:78-80
Timestamp: 2025-09-27T21:49:55.796Z
Learning: In the Armbian build system, kernel configuration files are generated through an automated process: taking previous config → applying scripted changes from armbian-kernel.sh → running kernel's `make oldconfig` → processing by Armbian machinery back into config files. This automated process properly handles kernel configuration dependencies and reduces the likelihood of manual configuration errors.

Applied to files:

  • .github/workflows/rewrite-kernel-config-files.yml
📚 Learning: 2025-08-02T05:46:10.664Z
Learnt from: EvilOlaf
Repo: armbian/build PR: 0
File: :0-0
Timestamp: 2025-08-02T05:46:10.664Z
Learning: In the Armbian build system, the modern recommended approach for kernel configuration is to use the kernel-config command via "./compile.sh BOARD=boardname BRANCH=branchname kernel-config" instead of the deprecated KERNEL_CONFIGURE=yes flag. This provides a two-step workflow: configure using menuconfig, then build, with better transparency and control over configuration changes.

Applied to files:

  • .github/workflows/rewrite-kernel-config-files.yml
📚 Learning: 2025-07-17T04:12:33.125Z
Learnt from: pyavitz
Repo: armbian/build PR: 8388
File: config/boards/kickpik2b.conf:1-14
Timestamp: 2025-07-17T04:12:33.125Z
Learning: In the Armbian build system, board configuration files (*.conf) follow a project standard of not including shebang lines, even though they contain bash code and are sourced by the build system. This is an established Armbian convention that individual contributors are expected to follow, and changes to this standard would require broader project maintainer approval.

Applied to files:

  • .github/workflows/rewrite-kernel-config-files.yml
📚 Learning: 2025-07-25T03:51:50.830Z
Learnt from: EvilOlaf
Repo: armbian/build PR: 8428
File: config/boards/lckfb-taishanpi.csc:5-9
Timestamp: 2025-07-25T03:51:50.830Z
Learning: When reviewing PRs in the Armbian build system, U-Boot defconfig files and patches may be added as part of the PR changes but might not be visible in the current repository clone state during review. It's important to check the actual PR file changes directly via GitHub or the PR API to get the complete picture of what files are being added or modified.

Applied to files:

  • .github/workflows/rewrite-kernel-config-files.yml
📚 Learning: 2025-09-14T11:42:45.142Z
Learnt from: igorpecovnik
Repo: armbian/build PR: 8636
File: .github/workflows/pr-label-on-approved.yml:38-54
Timestamp: 2025-09-14T11:42:45.142Z
Learning: In GitHub Actions workflows, the `workflow_run` trigger with `types: [completed]` combined with an upstream workflow that has conditional job execution (e.g., `if: ${{ github.event.review.state == 'approved' }}`) creates an effective approval gate. The downstream workflow only runs when the upstream workflow completes successfully, which only happens when the conditional is met.

Applied to files:

  • .github/workflows/label-pr-on-approval.yml
🔇 Additional comments (22)
.github/workflows/welcome-issue-first-time.yml (1)

1-1: LGTM! Cleaner, more concise workflow name.

The simplified name removes the redundant "issue" qualifier since the workflow trigger already makes it clear this is for issues.

.github/workflows/auto-label-pr.yml (1)

1-1: LGTM! Much more concise and action-oriented.

The new name follows the stated convention perfectly: action verb first, concise, with standard PR abbreviation.

.github/workflows/lint-pr-scripts.yml (1)

1-1: LGTM! More natural phrasing.

Removing the unnecessary preposition "on" makes the name more direct and grammatically cleaner.

.github/workflows/sync-board-list.yml (1)

1-1: LGTM! Better verb choice and consistent casing.

The verb "Sync" more accurately describes the workflow's purpose of synchronizing board lists with the armbian/os repository. The lowercase convention is also more consistent with the standardization effort.

.github/workflows/listen-pr-review.yml (1)

1-1: LGTM! Action-oriented naming.

Converting from the noun "listener" to the verb "Listen" aligns perfectly with the stated goal of making workflow names more action-oriented.

.github/workflows/cleanup-workflow-logs.yml (1)

1-1: LGTM! Consistent casing applied.

The change from title case to lowercase aligns with the standardized naming convention being applied across all workflows.

.github/workflows/sync-labels.yml (1)

1-1: LGTM! Removes unnecessary implementation detail.

The new name is more concise by removing "from YAML" - an implementation detail that doesn't need to be in the workflow display name.

.github/workflows/sync-tools.yml (1)

1-1: LGTM! Much more concise while maintaining clarity.

The simplified name removes unnecessary detail ("in Scripts") while the verb "Sync" accurately describes the synchronization operation. The run-name retains more detail for individual workflow runs, which is appropriate.

.github/workflows/build-pr-artifacts.yml (1)

1-1: LGTM - Workflow name simplified effectively.

The rename from "Generate Artifacts on PR if 'Build' label exists" to "Build PR artifacts" follows the stated naming convention: verb-first, concise, and removes implementation details from the display name.

.github/workflows/label-pr-on-approval.yml (2)

1-1: LGTM - Improved clarity with verb-first naming.

The rename from "PR review labeler" to "Label PR on approval" better describes the workflow's action and timing.


4-4: Update the workflow reference to match the actual workflow name.

The code references "PR review listener" but the actual upstream workflow is named "Listen PR review" (from .github/workflows/listen-pr-review.yml). Update line 4 to reference "Listen PR review" instead.

Likely an incorrect or invalid review comment.

.github/workflows/check-pr-pictures.yml (1)

1-1: LGTM - Significantly more concise naming.

The rename from "Check new board assets exist (images + vendor logos)" to "Check PR assets" removes verbose implementation details while maintaining clarity.

.github/workflows/create-jira-ticket.yml (1)

1-1: LGTM - Verb-first convention applied.

The reordering from "Jira Sync" to "Sync Jira" follows the stated convention of leading with the action verb.

.github/workflows/help-forked.yml (1)

1-1: LGTM - More action-oriented naming.

The change from "Forked Helper" (noun) to "Help forks" (verb + object) is more action-oriented and follows the verb-first convention.

.github/workflows/announce-pr.yml (1)

1-1: LGTM - Simplified by removing platform details.

The rename from "Announce PR on Discord for review" to "Announce PR" removes implementation details (Discord) from the display name, keeping it concise.

.github/workflows/sync-maintainers-status.yml (1)

1-1: LGTM - Concise without losing clarity.

The simplification from "Sync maintainers status" to "Sync maintainers" is more concise while the context remains clear from the workflow's purpose.

.github/workflows/announce-merge.yml (1)

1-1: LGTM - Streamlined naming.

The rename from "Announce PR merge to Discord" to "Announce merge" removes redundant words and platform-specific details for a cleaner display name.

.github/workflows/scorecard.yml (1)

1-1: LGTM! Workflow name standardized.

The rename to "Scan security" follows the action-verb-first convention and improves clarity.

.github/workflows/rewrite-kernel-config-files.yml (2)

1-1: LGTM! Quote removal aligns with standardization.

Removing quotes from the workflow name is a stylistic improvement consistent with the PR's naming convention updates.


245-245: Critical: Filename reference correctly updated.

This update is essential since the workflow file itself was renamed from rewrite-kernel-configs.yml to rewrite-kernel-config-files.yml. The generated PR body will now correctly link to the new filename.

.github/workflows/welcome-pr-first-time.yml (1)

1-1: LGTM! Consistent quote removal.

The quote removal maintains consistency with other workflow files in this PR.

.github/workflows/analyze-pr-kernel-security.yml (1)

1-2: LGTM! Improved workflow naming and run context.

The workflow name now follows the action-verb-first convention, and the run-name provides better context by including PR metadata.


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 added size/small PR with less then 50 lines Needs review Seeking for review GitHub Actions GitHub Actions code 02 Milestone: First quarter release labels Dec 25, 2025
@igorpecovnik igorpecovnik merged commit 28f5839 into main Dec 25, 2025
10 of 11 checks passed
@igorpecovnik igorpecovnik deleted the chore/rename-workflow-files branch December 25, 2025 11:00
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

02 Milestone: First quarter release GitHub Actions GitHub Actions code Needs review Seeking for review size/small PR with less then 50 lines

Development

Successfully merging this pull request may close these issues.

2 participants