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

Use appropriate default value for sketches-report-path input #7

Merged
merged 1 commit into from
Sep 16, 2020
Merged

Use appropriate default value for sketches-report-path input #7

merged 1 commit into from
Sep 16, 2020

Conversation

per1234
Copy link
Collaborator

@per1234 per1234 commented Sep 16, 2020

In the time since it was first conceived, the use of the report file created by the compile-sketches action has been expanded from only being a way to pass memory usage change data to the arduino/report-size-deltas action to a general purpose report of data generated from the sketch compilations, including:

  • Non-deltas size data consumed by arduino/report-size-trends
  • Compilation status for each sketch/board combination
  • Compiler warning count

It's possible additional information will be added to the report over time.

For this reason, the previous default size-deltas-reports was no longer appropriate and might be the source of confusion.

Unfortunately, this is a breaking change for people who:

  • Did not specify a value to the sketches-report-path input and,
  • have an additional step in their workflow (e.g., actions/upload-artifact) that relies on the sketches reports being located under the folder resulting from the previous default

In the time since it was first conceived, the use of the report file created by the compile-sketches action has been expanded from only being a way to pass memory usage change data to the report-size-deltas action to a general purpose report of data generated from the sketch compilations, including:

- Non-deltas size data consumed by arduino/report-size-trends
- Compilation status for each sketch/board combination
- Compiler warning count

It's possible additional information will be added to the report over time.

For this reason, the previous default `size-deltas-reports` was no longer appropriate and might be the source of confusion.

Unfortunately, this is a breaking change for people who:

- Did not specify a value to the sketches-report-path input and,
- have an additional step in their workflow (e.g., actions/upload-artifact) that relies on the sketches reports being located under the folder resulting from the previous default
@per1234 per1234 added the type: enhancement Proposed improvement label Sep 16, 2020
Copy link
Collaborator

@aentinger aentinger left a comment

Choose a reason for hiding this comment

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

Although a breaking change those are sometimes necessary. As we are currently our own best action customer I agree on doing this breaking change now before the actions get widespread usage. Good work @per1234 🚀

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
type: enhancement Proposed improvement
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants