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

Automation Script To Update The WIKI on Issue Closure #110

Open
5 tasks
DeviPriya-Kolla opened this issue Nov 15, 2024 · 2 comments
Open
5 tasks

Automation Script To Update The WIKI on Issue Closure #110

DeviPriya-Kolla opened this issue Nov 15, 2024 · 2 comments
Assignees

Comments

@DeviPriya-Kolla
Copy link
Collaborator

DeviPriya-Kolla commented Nov 15, 2024

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
@DeviPriya-Kolla DeviPriya-Kolla self-assigned this Nov 25, 2024
@kate-holdener
Copy link
Contributor

kate-holdener commented Dec 10, 2024

@DeviPriya-Kolla What is the purpose of this Wiki and why would we want to duplicate information into it? GitHub already keeps information about closed issues, when they were closed, and with what PR (if developers properly tag their PRs)

@DeviPriya-Kolla
Copy link
Collaborator Author

Like we have to go through all the issues to understand what features are implemented or closed, instead with every closed issue if we update the wiki, we will have all the information in one place.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants