Skip to content

feat: Add script for reporting maintenance chart pass/fail coverage#1008

Merged
sarina merged 1 commit into
openedx:mainfrom
jswope00:jswope00/maintenance_chart_report
Apr 16, 2025
Merged

feat: Add script for reporting maintenance chart pass/fail coverage#1008
sarina merged 1 commit into
openedx:mainfrom
jswope00:jswope00/maintenance_chart_report

Conversation

@jswope00
Copy link
Copy Markdown
Contributor

Script provides the ability to generate reports on maintenance chart empty/pass/fail coverage:
image

You can specify a particular directory:
image

And/or the levels of directories to group your report by:
image

@openedx-webhooks openedx-webhooks added the open-source-contribution PR author is not from Axim or 2U label Apr 16, 2025
@openedx-webhooks
Copy link
Copy Markdown

openedx-webhooks commented Apr 16, 2025

Thanks for the pull request, @jswope00!

This repository is currently maintained by @openedx/docs-openedx-org-maintainers.

Once you've gone through the following steps feel free to tag them in a comment and let them know that your changes are ready for engineering review.

🔘 Get product approval

If you haven't already, check this list to see if your contribution needs to go through the product review process.

  • If it does, you'll need to submit a product proposal for your contribution, and have it reviewed by the Product Working Group.
    • This process (including the steps you'll need to take) is documented here.
  • If it doesn't, simply proceed with the next step.
🔘 Provide context

To help your reviewers and other members of the community understand the purpose and larger context of your changes, feel free to add as much of the following information to the PR description as you can:

  • Dependencies

    This PR must be merged before / after / at the same time as ...

  • Blockers

    This PR is waiting for OEP-1234 to be accepted.

  • Timeline information

    This PR must be merged by XX date because ...

  • Partner information

    This is for a course on edx.org.

  • Supporting documentation
  • Relevant Open edX discussion forum threads
🔘 Get a green build

If one or more checks are failing, continue working on your changes until this is no longer the case and your build turns green.

Details
Where can I find more information?

If you'd like to get more details on all aspects of the review process for open source pull requests (OSPRs), check out the following resources:

When can I expect my changes to be merged?

Our goal is to get community contributions seen and reviewed as efficiently as possible.

However, the amount of time that it takes to review and merge a PR can vary significantly based on factors such as:

  • The size and impact of the changes that it introduces
  • The need for product review
  • Maintenance status of the parent repository

💡 As a result it may take up to several weeks or months to complete a review and merge your PR.

@github-project-automation github-project-automation Bot moved this to Needs Triage in Contributions Apr 16, 2025
@jswope00 jswope00 requested a review from sarina April 16, 2025 16:42
@sarina sarina marked this pull request as ready for review April 16, 2025 19:29
@sarina
Copy link
Copy Markdown
Contributor

sarina commented Apr 16, 2025

This is awesome. I think I'm going to put this in a weekly? biweekly? cron job, and make a PR to update this chart in the README (probably in the "Submit documentation issues" section). I'll write that up Friday.

@sarina sarina moved this from Needs Triage to In Eng Review in Contributions Apr 16, 2025
This script analyzes maintenance charts in reStructuredText (.rst) files. It recursively scans
through directories looking for .rst files containing maintenance charts in the format:

**Maintenance chart**
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

The Site Ops dir doesn't bold the maintenance chart title, and the Community pages have no maintenance charts at all. I'll fix this so we get a more accurate report.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

@sarina sarina merged commit 499ff56 into openedx:main Apr 16, 2025
2 checks passed
@github-project-automation github-project-automation Bot moved this from In Eng Review to Done in Contributions Apr 16, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

open-source-contribution PR author is not from Axim or 2U

Projects

Archived in project

Development

Successfully merging this pull request may close these issues.

3 participants