Skip to content

Automation Script To Update The WIKI on Issue Closure #110

Description

@DeviPriya-Kolla

Is your feature request related to a problem? Please describe.
Our team currently lacks a standardized process for updating the Wiki when issues are closed. This leads to inconsistent or missing documentation of changes, features, and fixes.

Describe the solution you'd like
A clear, structured process for manually updating the Wiki when issues are closed:

  1. A template for Wiki updates that includes:
    - Feature/fix description
    - Usage instructions like API details or the component navigation details etc
    - Configuration details (if applicable)
    - Related issue/PR references
  2. A designated section in issue/PR templates for Wiki content
  3. Clear guidelines on which types of changes require Wiki updates
  4. A standard location/structure in the Wiki for different types of updates

Acceptance criteria

  • Script automatically triggers when an issue is marked as closed in GitHub
  • Script extracts relevant documentation content from the issue (specifically from a designated "Wiki Documentation" section in the issue)
  • If a "Wiki Documentation" section exists in the issue:
    - Script identifies the appropriate Wiki page to update based on tags/categories
    - Successfully adds the new content to the existing Wiki page
    - Maintains proper markdown formatting
    - Adds metadata (issue number, closure date, contributor)
  • If no Wiki documentation section exists, script skips the issue without error
  • Script notifies relevant team members (via GitHub comment or other specified channel) when:
    - Wiki update is successful
    - Update fails for any reason

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Labels

No labels
No labels

Type

No type

Projects

No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions