Skip to content

Commit

Permalink
Fix documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
jadchaar committed Sep 30, 2023
1 parent ce128fd commit dce4203
Showing 1 changed file with 4 additions and 14 deletions.
18 changes: 4 additions & 14 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -506,21 +506,11 @@ Release

In order to create a new release, complete the following steps:

1. Outline changes made in the new release in :code:`CHANGELOG.md`.
2. Bump the version in :code:`_version.py` and push change to master branch.
1. Outline changes made in the new release in ``CHANGELOG.md``.
2. Bump the version in ``_version.py`` and push change to master branch.
3. Ensure all unit and integration tests pass locally and in the GitHub Actions testing workflow.
4. Create a tag with the same version number specified in :code:`_version.py`. For example, if you are releasing v5.0.1, run the following:

.. code-block:: bash
# Create tag
$ git tag 5.0.1 master
# Push a single tag to origin
$ git push origin 5.0.1
5. Once the tag is pushed, a `GitHub Actions release workflow <https://github.com/jadchaar/sec-edgar-downloader/actions/workflows/release.yml>`_ will be
kicked off that automatically creates the package artifacts and uploads them to PyPI.
4. Create a tag with the same version number specified in ``_version.py``. For example, if you are releasing v5.0.1, run the following to create and push a single tag: ``git tag 5.0.1 master && git push origin 5.0.1``.
5. Once the tag is pushed, a `GitHub Actions release workflow <https://github.com/jadchaar/sec-edgar-downloader/actions/workflows/release.yml>`_ will be kicked off that automatically creates the package artifacts and uploads them to PyPI.
6. Create a new version based off of the published tag on the `GitHub repository's release page <https://github.com/jadchaar/sec-edgar-downloader/releases>`_.

Documentation
Expand Down

0 comments on commit dce4203

Please sign in to comment.