Skip to content

Commit

Permalink
Add to doc release process for maintainers
Browse files Browse the repository at this point in the history
  • Loading branch information
osaajani committed Jan 10, 2025
1 parent 49fdce1 commit d2d3cc4
Show file tree
Hide file tree
Showing 3 changed files with 66 additions and 0 deletions.
6 changes: 6 additions & 0 deletions docs/developer_guide/developers_install.rst
Original file line number Diff line number Diff line change
Expand Up @@ -46,6 +46,12 @@ And you can lint with:
$ python -m black .
and

.. code:: bash
$ python3 -m flake8 -v --show-source --max-line-length=92 moviepy docs/conf.py examples tests
1 change: 1 addition & 0 deletions docs/developer_guide/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -11,3 +11,4 @@ The Developers Guide covers most of the things people wanting to participate to

developers_install
contribution_guidelines
maintainers_publish
59 changes: 59 additions & 0 deletions docs/developer_guide/maintainers_publish.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,59 @@
.. _maintainers_publish:

Publishing a New Version of MoviePy
===================================

This section is for maintainers responsible for publishing new versions of MoviePy. Follow these steps to ensure the process is smooth and consistent:

**Pre-requisites**
------------------
- Ensure you have proper permissions to push changes and create releases in the MoviePy repository.

Steps to Publish a New Version
------------------------------

1. **Update the `CHANGELOG.md`**

- Add a new section for the upcoming version, respecting the format used in previous entries.
- Summarize all changes, fixes, and new features.

2. **Update the version in `pyproject.toml`**

- Open the `pyproject.toml` file.
- Update the `version` field to the new version, following `Semantic Versioning <https://semver.org/>`_.

3. **Commit and Push**

- Stage your changes::

git add CHANGELOG.md pyproject.toml

- Commit your changes::

git commit -m "Release vX.Y.Z"

- Push your changes::

git push

4. **Create a New Tag**

- Create a tag for the new version (replace ``vX.Y.Z`` with the actual version number)::

git tag -a vX.Y.Z -m "Release vX.Y.Z"

- Push the tag to the remote repository::

git push origin vX.Y.Z

5. **Create a New Release**

- Go to the repository's page on GitHub (or the relevant hosting platform).
- Navigate to the "Releases" section and create a new release.
- Use the new tag (``vX.Y.Z``) and provide a description for the release.
- Copy the changelog for this version into the release description.
- Publish the release.

GitHub actions will automatically build and publish the new release on PyPi.

By following these steps, you ensure that each MoviePy release is well-documented, correctly versioned, and accessible to users.

0 comments on commit d2d3cc4

Please sign in to comment.