Skip to content

Commit 07b503d

Browse files
authored
[REL] Prepare for 0.9.6 release (#501)
* DOC: Remove calls to master, develop branches: just main * DOC: Instruct jupyter execute over notebook test script
1 parent d8f02d1 commit 07b503d

File tree

4 files changed

+8
-25
lines changed

4 files changed

+8
-25
lines changed

docs/develop/checklist.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -61,7 +61,7 @@ in the package. These are converted to be used in our main documentation, and se
6161
as a handy way for new users to discover the features provided with ``serpentTools``.
6262
In order to ensure that these are valid notebooks as changes are introduced, our :term:`CI`
6363
converts these to python scripts and runs them using
64-
`the test notebooks script <https://github.com/CORE-GATECH-GROUP/serpent-tools/blob/develop/scripts/travis/testNotebooks.sh>`_.
64+
``jupyter execute``.
6565
It is beneficial to run this script during major changes to the API, as well as correcting any
6666
errors or deprecated/removed features.
6767

@@ -81,7 +81,7 @@ the lint that would be introduced with
8181

8282
.. code::
8383
84-
$ git diff --unified=0 develop | flake8 --diff
84+
$ git diff --unified=0 main | flake8 --diff
8585
86-
Here, ``develop`` is the intended target branch into which these changes
86+
Here, ``main`` is the intended target branch into which these changes
8787
will be merged.

docs/develop/contributing.rst

Lines changed: 5 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -63,7 +63,7 @@ Pull Requests
6363
=============
6464

6565
Pull requests are how we review, approve, and incorporate changes into
66-
the ``master`` branch. If you have code you want to
66+
the ``main`` branch. If you have code you want to
6767
contribute, please look at the content in the :ref:`dev-guide`
6868
for things like :ref:`pr-checklist`, :ref:`code-style`, and more.
6969

@@ -73,14 +73,9 @@ and make a request!
7373
Someone of the core development team will review the changes according
7474
to the criteria above and make changes and/or approve for merging!
7575

76-
The ``develop`` branch is the primary branch for this project.
76+
The ``main`` branch is the primary branch for this project.
7777
All pull requests, except for bugs on public releases, should be compared against this branch.
7878
When a pull request is approved and has passed the required checks, it should be
79-
`squashed and merged <https://github.com/blog/2141-squash-your-commits>`_ into the develop branch.
80-
Squashing a branch converts a series of commits into a single commit onto the main branch,
81-
creating a tidy git history.
82-
83-
For pull requests into ``master``, as in releases, these should simply be merged without squashing.
84-
When viewing the ``git log`` on the ``master`` or ``develop`` branches, one is presented only with
85-
approved and closed pull requests, not incremental commits that led to a PR being closed.
86-
79+
`squashed and merged <https://github.com/blog/2141-squash-your-commits>`_ into the
80+
``main`` branch. Squashing a branch converts a series of commits into a single commit
81+
onto the main branch, creating a tidy git history.

docs/develop/git.rst

Lines changed: 0 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -6,14 +6,6 @@ Version Control
66

77
``serpentTools`` uses :term:`git` for version control. All the source
88
code can be found at https://github.com/CORE-GATECH-GROUP/serpent-tools.
9-
Two main branches are provided: ``master`` and ``develop``, and the
10-
`git flow <https://nvie.com/posts/a-successful-git-branching-model/>`_ branching
11-
model is followed.
12-
The ``master`` branch should be considered stable and updated coincident with
13-
each release.
14-
The ``develop`` branch is updated with more frequency as features are introduced.
15-
This is the main branch of the project, and features should be introduced off
16-
of this branch.
179

1810
``serpentTools`` follows the `semantic versioning <https://semver.org/>`_
1911
system, where the version number as found in ``setup.py``,

docs/index.rst

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -8,10 +8,6 @@ Welcome to serpentTools's documentation!
88

99
.. only:: html
1010

11-
.. image:: https://travis-ci.org/CORE-GATECH-GROUP/serpent-tools.svg?branch=develop
12-
:target: https://travis-ci.org/CORE-GATECH-GROUP/serpent-tools
13-
:alt: Build status - develop
14-
1511
.. image:: https://readthedocs.org/projects/serpent-tools/badge/?version=latest
1612
:target: http://serpent-tools.readthedocs.io/en/latest/?badge=latest
1713
:alt: Documentation Status

0 commit comments

Comments
 (0)