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

Create a new GitHub action that adds/removes "community-contribution-in-progress" label on issues #12923

Open
2 tasks
MisRob opened this issue Dec 10, 2024 · 7 comments
Assignees
Labels
github_actions Pull requests that update GitHub Actions code help wanted Open source contributors welcome P2 - normal Priority: Nice to have

Comments

@MisRob
Copy link
Member

MisRob commented Dec 10, 2024

Summary

Create a new GitHub action that adds/removes "community-contribution-in-progress" label on issues.

Image

  • When an external contributor is assigned to an issue, the action should add the "community-contribution-in-progress" label to the issue
  • When an external contributor is unassigned from an issue, the action should remove the "community-contribution-in-progress" label

This needs to be a shared action with most of its logic placed in the .github repository. This shared part will then be called from the following repositories:

A. kolibri
B. kolibri-design-system
C. studio
D. ricecooker
E. le-utils

Guidance

Development process

  • For ease of development, at first work on your own two repositories
  • Test as many areas as possible manually

Later during the review process, we can offer guidance in areas specific to integration with our ecosystem, such as private secrets, etc.

Opening pull requests

To allow for smooth review and testing process, we'd ask you to organize pull requests as follows:

  • (1) The 1st pull request with the re-usable shared logic to target the .github repository
  • (2) The 2nd pull request with a small action that re-uses (1) to target the test-actions repository. Imagine test-actions as a temporary representative of (A-E) repositories listed above.

Only after we have reviewed the two pull requests above, the final 5 pull requests can be open to (A-E) repositories. You will be instructed by a team member when the time comes to do so.

See the following action for an example:

3rd party workflows

  • For security and upgrade reasons, we prefer our own implementation together with official 3rd party workflows if needed.

Programming language

  • Generally for more complex actions, use JavaScript or Python scripts rather than bash.

Implementation

  • To identify external contributors, use their association: it shouldn't be MEMBER and neither OWNER

Acceptance criteria

  • The action adds/removes the label when an external contributor is assigned/unassigned an issue
  • The action ignores issues assigned/unassigned to core team members
@MisRob MisRob added github_actions Pull requests that update GitHub Actions code help wanted Open source contributors welcome P2 - normal Priority: Nice to have labels Dec 10, 2024
@adibmbrk
Copy link

Hi @MisRob, can i get this issue assigned to me?

@iamshobhraj
Copy link
Contributor

iamshobhraj commented Dec 10, 2024

hi @MisRob, can i get this assigned?

@MisRob
Copy link
Member Author

MisRob commented Dec 10, 2024

Hi @iamshobhraj, I will assign you, thank you.

@adibmbrk Thanks for volunteering! I'm sorry, I offered the issue on some of our channels where @iamshobhraj is a member due to some previous contribution, so will reserve this. I believe there may still be other 'help wanted' and we will add more next year, if that'd be of your interest.

@MisRob
Copy link
Member Author

MisRob commented Dec 17, 2024

Hi @iamshobhraj, I wanted to mention that Learning Equality will be closed from December 23 to January 5.

@iamshobhraj
Copy link
Contributor

Happy New Years, @MisRob ! 🎉

I've completed the workflow that manages labels on issues with external contributors. It’s working perfectly in my personal repository, test-actions. This workflow leverages reusable logic from another repository of mine, .github.

Since I had to use this GitHub Action in my personal repository, I created and used GitHub tokens. For the organization, we'll need to ensure we have a similar token set up if it isn’t already covered.

@marcellamaki
Copy link
Member

Hi @iamshobhraj - thank you for the update and your contribution! We do have github tokens that we use for many of our github actions, but I am not sure about the specifics of this use case, and what might be required for properly configuring that in your PR. @MisRob will be out of the office for the new year still until next week, and she will follow up with you after her return. Happy new year!

@MisRob
Copy link
Member Author

MisRob commented Jan 16, 2025

Hi @iamshobhraj, that's wonderful, thanks. You're welcome to open pull requests to those two repositories and we will coordinate with you on tokens.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
github_actions Pull requests that update GitHub Actions code help wanted Open source contributors welcome P2 - normal Priority: Nice to have
Projects
None yet
Development

No branches or pull requests

4 participants