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

actions(update-tools): avoid notifying our outdated deps everywhere #7709

Merged
merged 1 commit into from
Jan 21, 2025

Conversation

akinomyoga
Copy link
Contributor

Description

Please include a summary of the change and which issue is fixed. Please also include relevant motivation and context. List any dependencies that are required for this change.

In the current main branch, workflow update-tools includes the content of the upstream release notes in the created GitHub Issue. This triggers a notification to every upstream contributor mentioned in the release note. This also creates a cross-reference link to our GitHub issue, which reports that our dependency is not up-to-date, in every issue and pull request in the upstream. The information that we need to update our dependency is not relevant to the upstream contributors, issues, and pull requests at all. We should avoid this situation.

In addition, this project has thousands of forks, and all the fork repositories that enabled GitHub Actions do the same at the same time, i.e., an upstream contributor receives several tens of notifications from fork repositories, and an upstream issue receives several tens of cross-reference links to fork repositories. We should have avoided this situation, but it's kind of too late. Even if we update the workflow specification in this repository, the workflow of the fork won't be updated unless the fork pulls our latest commit. We need to ask all these 54 fork repositories currently generating notifications one by one. Anyway, we should still consider updating our workflow to prevent future forks from starting to create an even larger number of notifications to the upstream contributors and issues.

First, we do not need to include a copy of the upstream release note. We can just put a link to the upstream release note. Currently, we anyway hide the content in the <details> tag and require the reader to press the button. The user experience is not so different from pressing a link and visiting the upstream release note.

GitHub issue reference: #7706
Jira reference number [AR-9999]

How Has This Been Tested?

Please describe the tests that you ran to verify your changes. Please also note any relevant details for your test configuration.

I have run the workflow in my fork repository:

https://github.com/akinomyoga/armbian-build/actions/workflows/update-tools.yml

and observed the results:

https://github.com/akinomyoga/armbian-build/pulls

Checklist:

Please delete options that are not relevant.

  • My code follows the style guidelines of this project
  • I have performed a self-review of my own code
  • I have commented my code, particularly in hard-to-understand areas: This change essentially removes the code, so there is no new hard-to-understand part.
  • My changes generate no new warnings
  • Any dependent changes have been merged and published in downstream modules: This change is unrelated to any dependency.

In the current main branch, workflow update-tools includes the content
of the upstream release notes in the created GitHub Issue.  This
triggers a notification to every upstream contributor mentioned in the
release note.  This also creates a cross-reference link to our GitHub
Issue (reporting that our dependency is not up-to-date) in every
upstream issue and pull request.  The information that we need to
update our dependency is not relavant to the upstream contributors,
issues, and pull requests at all.  We should avoid this situation.

In the first place, we do not need to include a copy of the upstream
release note.  We can just put a link to the upstream release note.
Currently, we anyway hide the content in the <details> tag and require
the reader to press the button.  The user experience is not so
different from pressing a link and visiting the upstream release note.
@github-actions github-actions bot added size/small PR with less then 50 lines Needs review Seeking for review GitHub Actions GitHub Actions code labels Jan 16, 2025
@akinomyoga
Copy link
Contributor Author

@dtolnay @cyqsimon @mr-toolcraft I created a PR for #7706. We should refrain from leaving further comments directly in #7706 as it would be broadcast to all the people mentioned in the original release note, so let's discuss anything related to #7706 here.

@akinomyoga
Copy link
Contributor Author

@ColorfulRhino Could you also review this as the original author of the workflow?

@igorpecovnik
Copy link
Member

Apologize for the noise / spam. I realize now how this is not good. Thank you for the tip and PR!

Copy link
Member

@igorpecovnik igorpecovnik left a comment

Choose a reason for hiding this comment

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

Agree.

@igorpecovnik igorpecovnik added Ready to merge Reviewed, tested and ready for merge 02 Milestone: First quarter release and removed Needs review Seeking for review labels Jan 20, 2025
@igorpecovnik igorpecovnik merged commit 1fdd801 into armbian:main Jan 21, 2025
11 checks passed
@akinomyoga akinomyoga deleted the fix-update-tools branch January 21, 2025 12:32
@akinomyoga
Copy link
Contributor Author

Thanks!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
02 Milestone: First quarter release GitHub Actions GitHub Actions code Ready to merge Reviewed, tested and ready for merge size/small PR with less then 50 lines
Development

Successfully merging this pull request may close these issues.

2 participants