Skip to content

Switch to contributor-friendly approach to size deltas CI report #23

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 2 commits into from
Jun 30, 2021
Merged

Conversation

per1234
Copy link
Collaborator

@per1234 per1234 commented Jun 29, 2021

The CI system makes a report of the change to memory usage of the example sketches that results from the changes made in a pull request. It does this via a comment on the PR thread. In order to do that, it needs write permissions in the repository. As a security precaution, workflow runs triggered by a pull request from a fork are not given the necessary write permissions.

The workflow was added in the early development phase when the repository was still private. In that situation, the approach of triggering the deltas report from the pull_request event was the best (due to the limited allowance of GitHub Actions minutes for private repos) but now the repository is public (thus having unlimited free minutes) and it's important to get reports on pull requests that come from forks. So the approach of using a dedicated workflow triggered by the schedule event
(which does have write permissions) is better.

per1234 added 2 commits June 29, 2021 12:55
The CI system makes a report of the change to memory usage of the example sketches that results from the changes made in
a pull request. It does this via a comment on the PR thread. In order to do that, it needs write permissions in the
repository. As a security precaution, workflow runs triggered by a pull request from a fork are not given the necessary
write permissions.

The workflow was added in the early development phase when the repository was still private. In that situation, the
approach of triggering the deltas report from the pull_request event was the best but now the repository is public and
it's important to get reports on pull requests that come from forks. So the approach of using a dedicated
workflow triggered by the schedule event (which does have write permissions) is better.
The previous version of the workflow was configured for private repositories, thus the "-private", but we are now using
the version for public repositories, so the filename should be updated accordingly.
@per1234 per1234 added the type: enhancement Proposed improvement label Jun 29, 2021
@per1234 per1234 requested review from aentinger and pennam June 29, 2021 20:20
@aentinger aentinger merged commit ae799cb into arduino-libraries:main Jun 30, 2021
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