Skip to content
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

Add debug objects #15

Merged
merged 7 commits into from
May 10, 2023
Merged

Add debug objects #15

merged 7 commits into from
May 10, 2023

Conversation

laupow
Copy link
Collaborator

@laupow laupow commented May 8, 2023

Story: https://app.shortcut.com/particle/story/118223/

This PR:

  • aligns firmware binary output name with other Actions (artifact-path => firmware-path)
  • adds new output that points to the target directory with debug assets from the compile (target-path)
  • updates examples/docs to use the updated outputs

How to test

Run a local compile via env "INPUT_SOURCES-FOLDER=test/fixtures/single-file-firmware" env "INPUT_PARTICLE-PLATFORM-NAME=argon" env "INPUT_DEVICE-OS-VERSION=default" npm start (see dev docs)

  • There should be a new target directory with the elf, lst, hex, and map files in the folder you ran the command
  • you should see ::set-output name=target-path::target in the stdout/logs from the Action run

@laupow laupow requested review from keeramis and azenk May 8, 2023 10:46
@laupow laupow force-pushed the feature/target-artifacts branch 2 times, most recently from 82f0bb8 to 96946db Compare May 8, 2023 17:32
@laupow laupow force-pushed the feature/target-artifacts branch from 96946db to 5f24b04 Compare May 9, 2023 14:04
Copy link

@keeramis keeramis left a comment

Choose a reason for hiding this comment

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

I am able to verify this on my mac without issues.
A couple of observations that Matt and I talked about:

  1. Since I had the target directory in my user app directory, the binaries were duplicated in the /workspace/target and /workspace/target/target directories. As discussed, this could be a side effect of local testing and can be ignored.
  2. One recommendation is to use the app name instead of workspace.bin/.hex/etc (for example: workspace_myappname.bin. However, I am not sure if this is a useful recommendation in terms of the github actions and if it makes more sense to do hardcoded names on these files.

Thanks for the PR! It's great to see that we are one step closer to having (publicly) available .elf files that are needed for debugging.

Copy link

@keeramis keeramis left a comment

Choose a reason for hiding this comment

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

I am able to verify this on my mac without issues.
A couple of observations that Matt and I talked about:

  1. Since I had the target directory in my user app directory, the binaries were duplicated in the /workspace/target and /workspace/target/target directories. As discussed, this could be a side effect of local testing and can be ignored.
  2. One recommendation is to use the app name instead of workspace.bin/.hex/etc (for example: workspace_myappname.bin. However, I am not sure if this is a useful recommendation in terms of the github actions and if it makes more sense to do hardcoded names on these files.

Thanks for the PR! It's great to see that we are one step closer to having (publicly) available .elf files that are needed for debugging.

@laupow laupow merged commit 8153869 into main May 10, 2023
@laupow laupow deleted the feature/target-artifacts branch May 10, 2023 15:52
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