Skip to content

Work CI-CD #3154

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
wants to merge 4 commits into
base: main
Choose a base branch
from
Draft

Work CI-CD #3154

wants to merge 4 commits into from

Conversation

josesimoes
Copy link
Member

@josesimoes josesimoes commented Apr 14, 2025

Description

  • Test TI build.

Motivation and Context

How Has This Been Tested?

Screenshots

Types of changes

  • Improvement (non-breaking change that improves a feature, code or algorithm)
  • Bug fix (non-breaking change which fixes an issue with code or algorithm)
  • New feature (non-breaking change which adds functionality to code)
  • Breaking change (fix or feature that would cause existing functionality to change)
  • Config and build (change in the configuration and build system, has no impact on code or features)
  • Dev Containers (changes related with Dev Containers, has no impact on code or features)
  • Dependencies/declarations (update dependencies or assembly declarations and changes associated, has no impact on code or features)
  • Documentation (changes or updates in the documentation, has no impact on code or features)

Checklist

  • My code follows the code style of this project (only if there are changes in source code).
  • My changes require an update to the documentation (there are changes that require the docs website to be updated).
  • I have updated the documentation accordingly (the changes require an update on the docs in this repo).
  • I have read the CONTRIBUTING document.
  • I have tested everything locally and all new and existing tests passed (only if there are changes in source code).

Summary by CodeRabbit

  • Chores
    • Streamlined our continuous integration process by removing several legacy build targets.
    • Updated failure reporting to align with the refined build operations.
    • Added a new step to check the installed version of Ninja in the CI pipeline.
    • Simplified Ninja installation management by removing caching and downloading steps.

Copy link

coderabbitai bot commented Apr 14, 2025

Walkthrough

The Azure Pipelines YAML configuration has been modified by commenting out several build jobs for various targets (STM32, ESP32, NXP, Azure RTOS, WIN32, and nanoCLR CLI). Additionally, the Report_Build_Failure job was updated to remove its dependencies on these build processes, thereby altering the control flow of the CI/CD pipeline. Changes to the Ninja installation process were also made, simplifying it to a version check.

Changes

File Changes
azure-pipelines.yml Commented out build jobs for STM32, ESP32, NXP, Azure RTOS, WIN32, and nanoCLR CLI targets; modified Report_Build_Failure job to remove dependencies on the commented-out build jobs.
azure-pipelines-templates/download-install-ninja.yml Added new script step ninja --version with display name "Ninja Version Check"; removed tasks for caching, downloading, and extracting Ninja.

Sequence Diagram(s)

Old Pipeline Flow

sequenceDiagram
    participant P as Pipeline Trigger
    participant B as Build Jobs (STM32, ESP32, NXP, Azure RTOS, WIN32, nanoCLR CLI)
    participant R as Report_Build_Failure

    P->>B: Trigger build jobs
    B-->>P: Return build results
    P->>R: Forward build results for failure report
Loading

New Pipeline Flow

sequenceDiagram
    participant P as Pipeline Trigger
    participant R as Report_Build_Failure

    P->>R: Trigger report without build job dependencies
Loading

Tip

⚡💬 Agentic Chat (Pro Plan, General Availability)
  • We're introducing multi-step agentic chat in review comments and issue comments, within and outside of PR's. This feature enhances review and issue discussions with the CodeRabbit agentic chat by enabling advanced interactions, including the ability to create pull requests directly from comments and add commits to existing pull requests.

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between e5b47bc and 6b2dd49.

📒 Files selected for processing (1)
  • azure-pipelines-templates/download-install-ninja.yml (1 hunks)
🔇 Additional comments (1)
azure-pipelines-templates/download-install-ninja.yml (1)

11-13: Simplified Ninja Installation to Version Check

The new script step replaces the previous caching, downloading, and extraction tasks with a concise version check using ninja --version. This simplification reduces complexity in the pipeline configuration and is appropriate if you expect Ninja to be pre-installed in the build environment.

Suggestion: Verify that your CI/CD environments always provide Ninja. If there's any chance that Ninja might not be installed, consider adding a conditional step or a fallback mechanism to install it.


🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai plan to trigger planning for file edits and PR creation.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 0

🧹 Nitpick comments (2)
azure-pipelines.yml (2)

366-713: Non‑TI Build Jobs Removed from the Pipeline
The diff shows that multiple build jobs for targets not related to TI (such as STM32, ESP32, NXP, Azure RTOS, WIN32, and nanoCLR CLI) have been commented out. This effectively eliminates these builds from the CI/CD process and narrows the focus to TI SimpleLink targets, which aligns with the PR objective.

A couple of suggestions:

  • If these targets will no longer be built, it may be cleaner in the long run to remove the commented‐out code entirely instead of leaving it in place.
  • If you intend to re-enable these jobs later, please add a comment clarifying that these are temporarily disabled to help future maintainers.
🧰 Tools
🪛 YAMLlint (1.35.1)

[error] 654-654: trailing spaces

(trailing-spaces)


1447-1472: Refine Dependency and Condition in the Report_Build_Failure Job
In the Report_Build_Failure job, the dependency now only includes Build_TI_SimpleLink_targets (as intended after removing non‑TI build jobs), which is appropriate given the current pipeline focus. However, note that the condition expression shows a trailing comma inside the or() clause:

-          failed('Build_TI_SimpleLink_targets'),
+          failed('Build_TI_SimpleLink_targets')

Removing the trailing comma can help avoid potential YAML parsing or evaluation issues. Please verify that the updated condition correctly reports failures based solely on the TI build’s status.

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between ffa9cb6 and a89f136.

📒 Files selected for processing (1)
  • azure-pipelines.yml (2 hunks)
🔇 Additional comments (1)
azure-pipelines.yml (1)

1-35: Overall Pipeline Configuration Remains Consistent with CI/CD Objectives
The rest of the pipeline configuration (triggers, resource references, and the initial build options) remains unaffected. This helps ensure that the changes—focusing exclusively on the TI build—integrate well into the overall CI/CD strategy without introducing side effects.

🧰 Tools
🪛 YAMLlint (1.35.1)

[error] 1-1: wrong new line character: expected \n

(new-lines)

- Test TI build.
Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 0

🧹 Nitpick comments (1)
azure-pipelines.yml (1)

366-713: Temporary Disabling of Non-TI Build Jobs
A large section of the pipeline (from STM32, ESP32, NXP, Azure RTOS, WIN32, and nanoCLR CLI targets) has been commented out. This aligns with the PR objective of isolating and testing the TI build. Please ensure that:

  • This change is indeed temporary (or documented as permanent if intended) so that future maintainers understand the rationale.
  • A comment is added to explain that these jobs are intentionally disabled to focus on TI builds for CI/CD testing.

Suggested diff for an inline note:

@@
-  # ###############
+  # ###############
+  # TEMPORARILY DISABLED: Non-TI build jobs are commented out
+  # for CI/CD testing purposes as per PR #3154. Re-enable when appropriate.
🧰 Tools
🪛 YAMLlint (1.35.1)

[error] 654-654: trailing spaces

(trailing-spaces)

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between a89f136 and 1a5a791.

📒 Files selected for processing (1)
  • azure-pipelines.yml (2 hunks)
🔇 Additional comments (2)
azure-pipelines.yml (2)

636-713: TI SimpleLink Build Job Verification
The active job Build_TI_SimpleLink_targets appears configured with a matrix (e.g. target TI_CC1352R1_LAUNCHXL_915 with specific build options). Verify that the TI build options (such as -DRADIO_FREQUENCY=915 and the designated target series) are up‑to‑date and reflect the intended configuration for testing the TI build.

🧰 Tools
🪛 YAMLlint (1.35.1)

[error] 654-654: trailing spaces

(trailing-spaces)


1447-1463: Report Build Failure Job Dependency Update
The Report_Build_Failure job now depends solely on Check_Code_Style and Build_TI_SimpleLink_targets (instead of the previously included jobs now commented out). This simplified dependency is consistent with the removal of other build jobs. Please verify that this dependency change still captures all failure scenarios relevant for the CI/CD pipeline.

Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 0

🧹 Nitpick comments (2)
azure-pipelines.yml (2)

366-635: Disabled Non-TI Build Jobs (STM32, ESP32, NXP, etc.)
Several build jobs—including those for STM32, ESP32, and NXP targets—are now completely commented out in this section. This appears to be an intentional change to restrict the pipeline to only the TI build for this test.

Recommendation: Please ensure that this temporary disablement is well documented (in the commit message or supporting docs) so that these jobs can be re-enabled easily when needed. Alternatively, consider using a pipeline variable or conditional inclusion instead of commenting out large blocks of YAML to improve maintainability.


712-1470: Disabled Additional Reporting and Publishing Jobs
From this point onward, jobs related to Azure RTOS, WIN32 executable, nanoCLR CLI, mscorlib unit tests, changelog generation, and the build failure reporting step have been commented out. This streamlines the pipeline to focus solely on the TI build.

Recommendation: Verify that leaving these jobs disabled does not adversely affect any downstream processes (for example, artifact publishing or notifications) that might be expected in a full build. If these jobs will be re-enabled later, consider using feature flags or conditional YAML inclusion rather than commenting them out to ease maintenance.

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 1a5a791 and c083964.

📒 Files selected for processing (1)
  • azure-pipelines.yml (2 hunks)
🔇 Additional comments (1)
azure-pipelines.yml (1)

636-712: Enabled TI SimpleLink Build Job
The TI SimpleLink target is now the only active build job in this section. This aligns with the PR objective to test the TI build.

Recommendation: Confirm that all environment variables, toolchain settings, and any TI-specific configurations are still current and sufficient for your testing needs.

🧰 Tools
🪛 YAMLlint (1.35.1)

[error] 654-654: trailing spaces

(trailing-spaces)

Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 0

🧹 Nitpick comments (1)
azure-pipelines-templates/download-install-ninja.yml (1)

35-37: Enhance the Ninja Version Check step

The newly added step that runs ninja --version is a straightforward and effective way to ensure that Ninja is correctly installed and accessible via the PATH. This check helps catch misconfigurations early in the pipeline.

Optionally, consider verifying that the output meets a specific minimum version requirement if one is critical for your builds, or add explicit error handling to provide a more descriptive failure message when the command fails.

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between c083964 and e5b47bc.

📒 Files selected for processing (1)
  • azure-pipelines-templates/download-install-ninja.yml (1 hunks)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants