Skip to content

Use sketch compilation CI actions from their new dedicated repositories #207

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

Merged
merged 3 commits into from
Nov 27, 2020
Merged

Conversation

per1234
Copy link
Contributor

@per1234 per1234 commented Nov 16, 2020

The "smoke test" sketch compilation and reporting actions have been moved to dedicated repositories. The actions hosted at the old arduino/actions/libraries/* location will no longer be maintained.

Since the time the actions were migrated to the dedicated repositories, a breaking change was made to the default value of the sketches-report-path input, which required a change to the values of the name and path inputs of the actions/upload-artifact action.

Since the time the "Compile Examples" workflow was written, some improvements have been made to the API of the arduino/compile-sketches CI action. The previous API is still supported, but is deprecated and warnings are displayed in the workflow run log about this, which could result in confusion for contributors.


GitHub only runs scheduled workflows that are in the repository's default branch. This means that the changes made in this PR to the report size deltas workflow will not take effect until the PR is merged. However, the changes to the "Compile Examples" workflow will take effect immediately. The workflow artifact created by the Compile Examples workflow is now named "sketches-reports", but the artifact name the previous report size deltas workflow running in the master branch looks for is "size-deltas-reports". This means there will be no size deltas report comment on this PR, but after it is merged the size deltas report comments will resume as usual.


This PR fixes the failing report size deltas workflow (e.g., https://github.com/arduino-libraries/ArduinoIoTCloud/actions/runs/366203792), which is caused by a bug that was only fixed in the new arduino/report-size-deltas action repository. (the motivation for this PR)

The "smoke test" sketch compilation and reporting actions have been moved to dedicated repositories. The actions hosted
at the old `arduino/actions/libraries/*` location will no longer be maintained.

Since the time the actions were migrated to the dedicated repositories, a breaking change was made to the default value
of the `sketches-report-path` input, which required a change to the values of the `name` and `path` inputs of the
	`actions/upload-artifact` action.
The reliance on the `actions/upload-artifacts` action means that these values will always be hardcoded into the
workflow. The result is that if the default values of the inputs are changed, it breaks the workflow, even if the
changes are synchronized. So it's safest to not rely on the defaults.
Since the time the "Compile Examples" workflow was written, some improvements have been made to the API of the
`arduino/compile-sketches` CI action. The previous API is still supported, but is deprecated and warnings are displayed
in the workflow run log about this, which could result in confusion for contributors.
@aentinger
Copy link
Contributor

Can/Should we merge this one due to #209? I'm wondering how much they double in functionality.

@per1234
Copy link
Contributor Author

per1234 commented Nov 18, 2020

There's no doubled functionality. Either one will cause a merge conflict in the other, but it will be easy enough to rebase.

Even though the deltas report workflows are failing, the deltas reports are still being made (because the action is processing the new CI runs before hitting the expired one and breaking), so the bug in the old action isn't really causing any problems other than perhaps confusing someone if they look at the actions tab and see all those ugly ❌ . So there's no rush in merging this.

Copy link
Contributor

@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.

I'm moving on with this one, let's rebase the other.

@aentinger aentinger merged commit 16f13b3 into arduino-libraries:master Nov 27, 2020
@per1234 per1234 deleted the update-actions branch November 27, 2020 06:14
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