docs: migrate to scriv to manage changelog

[BryanttV]

Description

This PR installs and configures scriv to manage the changelog file.

This PR is based on the Tutor repository configuration.

Testing instructions

You can test the scriv commands running their corresponding Makefile commands:

• make changelog-entry (Run scriv create): This command will create a file in the changelog.d folder. You must edit it to describe your changes. This file must be committed. The contributor should use this command in each PR with changes.

• make changelog (Run scriv collect): This command will update the CHANGELOG. The previous files in the changelog.d will be removed and their content will be added in the CHANGELOG. This command only should be used in the release.yml workflow by a maintainer.

Deadline

None

Other information

• Scriv Documentation
• docs: migrate to scriv to manage changelog overhangio/tutor#745

Checklists

Check off if complete or not applicable:

Merge Checklist:

• All reviewers approved
• Reviewer tested the code following the testing instructions
• CI build is green
• Version bumped
• Changelog record added with short description of the change and current date
• Documentation updated (not only docstrings)
• Integration with other services reviewed
• Fixup commits are squashed away
• Unit tests added/updated
• Noted any: Concerns, dependencies, migration issues, deadlines, tickets

Post Merge:

• Create a tag
• Create a release on GitHub
• Check new version is pushed to PyPI after tag-triggered build is
  finished.
• Delete working branch (if not needed anymore)
• Upgrade the package in the Open edX platform requirements (if applicable)

[openedx-webhooks]

Thanks for the pull request, @BryanttV!

This repository is currently maintained by @openedx/committers-openedx-events.

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.

🔘 Update the status of your PR

Your PR is currently marked as a draft. After completing the steps above, update its status by clicking "Ready for Review", or removing "WIP" from the title, as appropriate.

---

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:

• Overview of Review Process for Community Contributions
• Pull Request Status Guide
• Making changes to your pull request

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.

[mariajgrimaldi]

We're working on a review here first: openedx/openedx-filters#268

[mphilbrick211]

Hi @BryanttV! Is this pull request still in progress?

[BryanttV]

Hi @mphilbrick211! Thanks for the ping.

@mariajgrimaldi, the PR that migrates to scriv in openedx-filters has already been merged. Should we do the same here, or do you think we need to address the changes in openedx/openedx-filters#284 first?

[mphilbrick211]

Hi @mphilbrick211! Thanks for the ping.

@mariajgrimaldi, the PR that migrates to scriv in openedx-filters has already been merged. Should we do the same here, or do you think we need to address the changes in openedx/openedx-filters#284 first?

Friendly ping on this, @mariajgrimaldi!

[BryanttV]

This PR will remain in Draft until the complete flow in openedx-filters is ready, so that it can be replicated here.