Skip to content
Permalink

Comparing changes

Choose two branches to see what’s changed or to start a new pull request. If you need to, you can also or learn more about diff comparisons.

Open a pull request

Create a new pull request by comparing changes across two branches. If you need to, you can also . Learn more about diff comparisons here.
base repository: arduino/report-size-deltas
Failed to load repositories. Confirm that selected base ref is valid, then try again.
Loading
base: ecf2382
Choose a base ref
...
head repository: arduino/report-size-deltas
Failed to load repositories. Confirm that selected head ref is valid, then try again.
Loading
compare: aa22d11
Choose a head ref
  • 4 commits
  • 4 files changed
  • 1 contributor

Commits on Jan 24, 2024

  1. Upload test sketches report workflow artifact 

    This sketches report artifact is used to get test size deltas reports.
    @per1234
    per1234 committed Jan 24, 2024
    Configuration menu
    Copy the full SHA
    b077ef3 View commit details
    Browse the repository at this point in the history

  2. Bump action dependencies in "Upload test sketches report artifact" wo… 

    …rkflow

`actions/upload-artifact` is only bumped to v3 here because a significant change in the artifact format was introduced
in 4.0.0. It is necessary for the workflow to continue to produce test data that provides integration test coverage for
compatibility of the action with the artifacts produced by <=v3 of the action.
    @per1234
    per1234 committed Jan 24, 2024
    Configuration menu
    Copy the full SHA
    39c0012 View commit details
    Browse the repository at this point in the history

  3. Upload multiple test data artifacts to provide coverage for artifact … 

    …name pattern feature

The action was originally designed for a use case where there will only be a single sketches reports workflow artifact.
Due to a change in the "actions/upload-artifact" GitHub Actions action, it became necessary to add the capability for
the "arduino/report-size-deltas" action to be able to consume reports from multiple artifacts.

The "Upload test sketches report artifact" GitHub Actions workflow is hereby updated to produce multiple test data
artifacts in order to allow the "Run integration tests" workflow to provide coverage for the new capability.

As was previously the case, one of the artifacts uploaded by the workflow contains multiple sketches report files in
order to provide test data necessary to continue providing coverage for the <=actions/upload-artifact@v3 single artifact
system. Even though the produced test data (multiple artifacts, with multiple reports in a single artifact) would not
occur under real world usage, it is the cleanest way (the alternative being to create and maintain separate copies of
the system implemented in the `report-target-pr` branch for each use pattern) to provide effective integration test
coverage.
    @per1234
    per1234 committed Jan 24, 2024
    Configuration menu
    Copy the full SHA
    e99610b View commit details
    Browse the repository at this point in the history

  4. Generate v1 and v2 format test data artifacts 

    A significant change was made to the nature of GitHub Actions workflow artifacts starting from the 2.x release of the
`@actions/artifact` package, which was introduced in the 4.0.0 release of the "actions/upload-artifact" GitHub Actions
action.

It is necessary to provide integration test coverage for compatibility of the "arduino/report-size-deltas" action with
the v2 format artifacts produced by actions/upload-artifact@v4. It is also important to continue to cover compatibility
with the v1 format artifacts produced by actions/upload-artifact@v3, to support users who have not gotten around to
updating that action dependency in their sketch compilation workflows (especially since the breaking change introduced
by actions/upload-artifact@v4 will make it necessary to adjust the configuration of the workflow).

The chosen approach is to configure the "Upload test sketches report artifact" workflow to use
actions/upload-artifact@v3 when upload one of the test data artifacts and actions/upload-artifact@v4 when uploading the
other. Even though the produced test data would not occur under real world usage, it is the cleanest way (the
alternative being to create and maintain separate copies of the system implemented in the `report-target-pr` branch for
each major version of the actions/upload-artifact action) to provide effective integration test coverage.
    @per1234
    per1234 committed Jan 24, 2024
    Configuration menu
    Copy the full SHA
    aa22d11 View commit details
    Browse the repository at this point in the history
Loading