GitHub Actions: Create issues to update wiki articles on a set schedule

[Aveline-art]

Dependency

• Updating Wiki: Move Current Wiki to New Repository #3636
• Use Jekyll Doc or MkDocs for Hack for LA project documentation #1534
• Audit and reorg HfLA website wiki #2676

Overview

As a developer on this team, we need to know schedule maintenance tasks so that all of our assets are up-to-date. For this issue, we will have a GHA create automatic issues to review and maintain certain wiki articles at a scheduled time.

Psudo-code

• Trigger: At a certain, scheduled time (as a placeholder, use the workflow_dispatch trigger event to test your script)
  • GHA bot will accept a list of either wiki links, titles, or both.
  • For each wiki link/title, create an issue with these criteria:
    • The title needs to contain the wiki's title and describe what the issue is for
    • The overview needs to be clear about the purpose of the issue
    • Action items need to be clear, and specific. Some action items need to be left blank, however, for the issue approval team to fill in.
    • Resources and instructions need to contain links to the specific wiki.
  • After the creation of the above issues, create one more issue to update any other wiki articles. There is no need to link every other wiki, but there should be a link to the wiki itself. This will be a catch all for any other wikis that needs an update.
  • Also, ensure that the issue is placed in the correct column of the project board.
• Discuss with team on these points:
  • Which articles needs to be included in this list?
  • How often does this need to run (perhaps monthly)?
  • What action items, instructions, and resources can we prefill into this issue?
  • What labels should be pre-placed?
  • Should anyone be pre-assigned? Who?

Checks

• Ensure that the template for the issues exists in an md file outside the script. For example, the issues and title templates are best left in an external md. This will allow quick edits to the issue.
• Ensure that the list of wiki links/titles are easy to find and edit.
• When a list of 3 titles is fed into the GHA, only 4 issues are created.
• When a blank list is fed into the GHA, only 1 issue is created.

Resources/Instructions

Never done GitHub actions? Start here!

To start on this issue, if you have not, please explore the current GHAs we have as some already perform similar actions. They might inspire you, and help you get started a lot faster.

Note that you might want to do something outside the scope of the above psudo-code. If so, be sure to leave comments in your PR or this issue that justifies your reasoning. If you feel you need guidance, be sure to reach out! We cannot foresee whether this issue is solvable, or what hard decisions have to be made, but we would love to hear and help you!

Additional resources:

Events that trigger workflows
Workflow syntax for GitHub Actions
actions/github-script
GitHub RESTAPI
GitHub GraphQL

[ExperimentsInHonesty]

@Aveline-art I added the dependency
Dependency
Re organizing the wiki and publishing it in MKdocs or similar

Is this ok? or am I misunderstanding the issue?

[Aveline-art]

@ExperimentsInHonesty That's fine! I have added #1534 as a dependency.

[ExperimentsInHonesty]

@roslynwythe I moved this into the new issue review column because the dependency is resolved. Please add a ready for prioritization label if its ready.