Skip to content

Commit

Permalink
docs updates for new release
Browse files Browse the repository at this point in the history
  • Loading branch information
ejolly committed May 26, 2021
1 parent 1bbe98c commit 1e91f48
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 2 deletions.
4 changes: 2 additions & 2 deletions docs/contributing.rst
Original file line number Diff line number Diff line change
Expand Up @@ -11,15 +11,15 @@ Each new *pre-release* should proceed by opening a pull-request (PR) the against

Each new *stable* release should follow the following steps, the first of which can occur in two ways:

- Step 1: drop :code:`.devX` from version string (in :code:`pymer4/version.py`) in the code base via **either**:
- Step 1: drop :code:`.devX` from version string (in :code:`pymer4/version.py`) and update the release notes page in the docs via **either**:

- **Pre-merge** at least one commit in :code:`dev` for the PR against master, such that the merge will include updating the version string. In the illustration below, this is depicted by the dashed borders around the final merge into :code:`master`.

- **Post-merge** making a final commit to :code:`master` updating the version string. In the illustration below, this is depicted by the "final push" dashed commit circle on :code:`master` right before "tagged manual release" of :code:`v0.7.2`.

- Step 2: manually trigger a release on Github using a :code:`vM.N.P` version string where :code:`M.N.P` matches Step 1. In the illustration below, this is depicted by the right-most, salmon-colored "tagged manual release" commit to :code:`master`.

- **Note:** this is the version string entered *on Github* when publishing the release and specifically adds a :code:`v` prefix.
- **Note:** this is the version string entered *on Github* when publishing the release and should specifically contain a :code:`v` prefix.

- Step 3: immediately bump the version string on :code:`dev` to :code:`M.N.P+1.dev0` where :code:`M.N.P` refers to the version string from Step 1. In the illustration below, an example is shown on the left-side of the diagram immediately to the right of the "tagged manual release" of :code:`v0.7.1` on :code:`master`.

Expand Down
7 changes: 7 additions & 0 deletions docs/new.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,13 @@ What's New
==========
Historically :code:`pymer4` versioning was a bit all over the place but has settled down since 0.5.0. This page includes the most notable updates between versions but github is the best place to checkout more details and `releases <https://github.com/ejolly/pymer4/releases/>`_.

0.7.4
-----
- **Compatibility updates:**
- This version drops official support for Python 3.6 and adds support for Python 3.9. While 3.6 should still work for the most part, development support and testing against this version of Python will no longer continue moving forward.
- **New features:**
- :code:`utils.result_to_table` function nicely formats the :code:`model.coefs` output for a fitted model. The docstring also contains instructions on using this in conjunction with the `gspread-pandas <https://github.com/aiguofer/gspread-pandas>`_ library for "exporting" model results to a google sheet

0.7.3
-----
- **Bug fixes:**
Expand Down

0 comments on commit 1e91f48

Please sign in to comment.