add debug.c.j2 to final build #9

JoaoGSP · 2025-07-22T01:51:01Z

Summary by CodeRabbit

Chores
- Updated build process to include the debug.c.j2 file in all platform executables.

coderabbitai · 2025-07-22T01:51:07Z

Walkthrough

The GitHub Actions workflow for building Python executables was updated to include the debug.c.j2 file as additional data in all PyInstaller build commands across all platforms and build modes. No other workflow steps or configurations were changed.

Changes

File(s)	Change Summary
.github/workflows/build.yml	Updated all PyInstaller build commands to add `debug.c.j2` as data.

Estimated code review effort

1 (~2 minutes)

Possibly related PRs

Create Github Actions to generate compiled files #2: Adds the initial GitHub Actions workflow that this PR directly extends by including an extra data file in the PyInstaller build process.

Suggested labels

enhancement

Suggested reviewers

thiagoralves

Poem

A bunny hopped through YAML fields,
Adding files so nothing yields,
Now debug.c.j2 joins the show,
In every bundle, high and low!
🐇✨
With PyInstaller's gentle touch,
Our builds are stronger—thank you much!

📜 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 7c5628e and 150175e.

📒 Files selected for processing (1)

.github/workflows/build.yml (6 hunks)

🚧 Files skipped from review as they are similar to previous changes (1)

.github/workflows/build.yml

⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)

GitHub Check: build-windows-arm

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

🪧 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.
- Explain this complex logic.
- 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 explain this code block.
- @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 explain its main purpose.
- @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.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

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 generate sequence diagram to generate a sequence diagram of the changes in this PR.
@coderabbitai resolve resolve all the CodeRabbit review comments.
@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.

coderabbitai

Actionable comments posted: 1

🧹 Nitpick comments (1)

.github/workflows/build.yml (1)
36-38: Consider de-duplicating the PyInstaller step

The six build jobs now carry identical install + build logic differing only by minor flags.
A composite action or a matrix job would remove duplication and guarantee all platforms use the same flags in the future (reducing the chance of the separator bug above).

Example sketch (matrix for arch + os):
strategy:
  matrix:
    include:
      - os: macos-15    # darwin-arm
      - os: macos-13    # darwin-x64
      - os: ubuntu-22.04-arm
      - os: ubuntu-22.04
      - os: windows-11-arm
      - os: windows-2025
steps:
  - uses: actions/checkout@v4
  - uses: actions/setup-python@v5
    with: { python-version: '3.13' }
  - run: |
      python -m pip install --upgrade pip
      pip install lxml jinja2 black pyinstaller
  - run: >
      pyinstaller xml2st.py ${{ matrix.isBundled && '-F' || '' }}
      --add-data "plcopen${{ env.DATA_SEP }}plcopen"
      --add-data "debug.c.js${{ env.DATA_SEP }}."
This is optional but will make future maintenance easier.

Also applies to: 64-66, 97-99, 130-132, 158-160, 186-188

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 2535fe5 and 7c5628e.

📒 Files selected for processing (1)

.github/workflows/build.yml (6 hunks)

.github/workflows/build.yml

thiagoralves

In the future, we might need to map all data files and have them external to the pyinstaller bundle. Then if we need to modify them (plcopen xml files are a good example) we don't have to generate another build for the xml2st

add debug.c.j2 to final build

7c5628e

coderabbitai bot reviewed Jul 22, 2025

View reviewed changes

.github/workflows/build.yml Outdated Show resolved Hide resolved

update build script

150175e

JoaoGSP requested a review from thiagoralves July 23, 2025 12:09

JoaoGSP self-assigned this Jul 23, 2025

thiagoralves approved these changes Jul 23, 2025

View reviewed changes

thiagoralves merged commit e6f1396 into development Jul 24, 2025
7 checks passed

coderabbitai bot mentioned this pull request Jul 24, 2025

Update build.yml to correct data paths for PyInstaller #10

Merged

coderabbitai bot mentioned this pull request Aug 13, 2025

Rtop 38 add support for array on debug.c #11

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

add debug.c.j2 to final build #9

add debug.c.j2 to final build #9

Uh oh!

JoaoGSP commented Jul 22, 2025 •

edited by coderabbitai bot

Loading

Uh oh!

coderabbitai bot commented Jul 22, 2025 •

edited

Loading

Chat

Support

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (`.coderabbit.yaml`)

Documentation and Community

Uh oh!

coderabbitai bot left a comment

Uh oh!

Uh oh!

thiagoralves left a comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

add debug.c.j2 to final build #9

add debug.c.j2 to final build #9

Uh oh!

Conversation

JoaoGSP commented Jul 22, 2025 • edited by coderabbitai bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary by CodeRabbit

Uh oh!

coderabbitai bot commented Jul 22, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Walkthrough

Changes

Estimated code review effort

Possibly related PRs

Suggested labels

Suggested reviewers

Poem

Chat

Support

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (.coderabbit.yaml)

Documentation and Community

Uh oh!

coderabbitai bot left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

thiagoralves left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

JoaoGSP commented Jul 22, 2025 •

edited by coderabbitai bot

Loading

coderabbitai bot commented Jul 22, 2025 •

edited

Loading

CodeRabbit Configuration File (`.coderabbit.yaml`)