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

Project thread reminders #2251

Merged
merged 34 commits into from
Jun 5, 2023
Merged

Project thread reminders #2251

merged 34 commits into from
Jun 5, 2023

Conversation

zackkrida
Copy link
Member

@zackkrida zackkrida commented May 31, 2023

Fixes

Fixes #2250 by @zackkrida

Description

Adds a run-daily GitHub action which checks all project threads for comments in the last 14 days. If a thread hasn't been commented on, a comment is left on the issue asking the author to write an update. The comment is formatted like this:

Rendered:

Hi {recipient}, this project has not received an update comment in 14 days. Please leave an update comment as soon as you can. See the documentation on project updates for more information.

In markdown:

Hi @${recipient}, this project has not received an update comment in 14 days. Please leave an update comment as soon as you can. See the [documentation on project updates](https://docs.openverse.org/projects/planning.html#providing-project-updates) for more information.

Testing Instructions

This can be easily tested via a manual workflow run. Be sure to leave the Dry run box checked otherwise the script will leave comments on several project threads 😄

This testing mechanism has been removed. See the results below though!

You can see my latest run and it's results here.

The threads identified to update by the script, as of today (2023-05-31), are:

Which should be correct.

Checklist

  • My pull request has a descriptive title (not a vague title likeUpdate index.md).
  • My pull request targets the default branch of the repository (main) or a parent feature branch.
  • My commit messages follow best practices.
  • My code follows the established code style of the repository.
  • I added or updated tests for the changes I made (if applicable).
  • I added or updated documentation (if applicable).
  • I tried running the project locally and verified that there are no visible errors.
  • I ran the DAG documentation generator (if applicable).

Developer Certificate of Origin

Developer Certificate of Origin
Developer Certificate of Origin
Version 1.1

Copyright (C) 2004, 2006 The Linux Foundation and its contributors.
1 Letterman Drive
Suite D4700
San Francisco, CA, 94129

Everyone is permitted to copy and distribute verbatim copies of this
license document, but changing it is not allowed.


Developer's Certificate of Origin 1.1

By making a contribution to this project, I certify that:

(a) The contribution was created in whole or in part by me and I
    have the right to submit it under the open source license
    indicated in the file; or

(b) The contribution is based upon previous work that, to the best
    of my knowledge, is covered under an appropriate open source
    license and I have the right under that license to submit that
    work with modifications, whether created in whole or in part
    by me, under the same open source license (unless I am
    permitted to submit under a different license), as indicated
    in the file; or

(c) The contribution was provided directly to me by some other
    person who certified (a), (b) or (c) and I have not modified
    it.

(d) I understand and agree that this project and the contribution
    are public and that a record of the contribution (including all
    personal information I submit with it, including my sign-off) is
    maintained indefinitely and may be redistributed consistent with
    this project or the open source license(s) involved.

@zackkrida zackkrida requested review from a team as code owners May 31, 2023 21:17
@openverse-bot openverse-bot added this to Needs review in Openverse PRs May 31, 2023
@zackkrida zackkrida marked this pull request as draft June 1, 2023 13:54
@openverse-bot openverse-bot moved this from Needs review to In progress in Openverse PRs Jun 1, 2023
@zackkrida zackkrida added 🟧 priority: high Stalls work on the project or its dependents 🌟 goal: addition Addition of new feature 🤖 aspect: dx Concerns developers' experience with the codebase and removed 🚦 status: awaiting triage Has not been triaged & therefore, not ready for work labels Jun 1, 2023
@zackkrida zackkrida marked this pull request as ready for review June 1, 2023 14:14
@openverse-bot openverse-bot moved this from In progress to Needs review in Openverse PRs Jun 1, 2023
Copy link
Contributor

@sarayourfriend sarayourfriend left a comment

Choose a reason for hiding this comment

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

LGTM! Glad actions/github-script simplified things so much 👍 In the future if we want the niceties of having an import with type hints in our editors, we can always install the packages as development dependencies (or their @type package) and apply type information using JSDoc on the exported function.

@zackkrida
Copy link
Member Author

@sarayourfriend I made small updates here to:

  • Remove the functionality for manual runs
  • Add type hints
  • Actually pass variables to the graphql query rather than "hardcode" them in the query string

I think these are minimal enough that your review should remain valid.

Copy link
Contributor

@stacimc stacimc left a comment

Choose a reason for hiding this comment

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

LGTM -- double-checked the test output and looks great :)

Openverse PRs automation moved this from Needs review to Reviewer approved Jun 2, 2023
@krysal krysal removed the 🧱 stack: frontend Related to the Nuxt frontend label Jun 5, 2023
@zackkrida zackkrida merged commit 9c739b1 into main Jun 5, 2023
43 checks passed
Openverse PRs automation moved this from Reviewer approved to Merged! Jun 5, 2023
@zackkrida zackkrida deleted the project-thread-reminder branch June 5, 2023 21:17
@zackkrida zackkrida mentioned this pull request Jun 5, 2023
8 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
🤖 aspect: dx Concerns developers' experience with the codebase 🌟 goal: addition Addition of new feature 🟧 priority: high Stalls work on the project or its dependents 🧱 stack: mgmt Related to repo management and automations
Projects
Archived in project
Openverse PRs
  
Merged!
Development

Successfully merging this pull request may close these issues.

Automated reminders for project thread updates
5 participants