Skip to content

Commit c84fc2c

Browse files
committed
Add release strategy
1 parent 50d604e commit c84fc2c

File tree

2 files changed

+34
-0
lines changed

2 files changed

+34
-0
lines changed

index.rst

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -99,6 +99,15 @@ Projects
9999
.. |mock-badge| image:: https://img.shields.io/github/stars/sphinx-notes/mock.svg?style=social&label=Star&maxAge=2592000
100100
:target: https://github.com/sphinx-notes/mock
101101

102+
Documentations
103+
==============
104+
105+
.. toctree::
106+
:caption: Documentations
107+
:glob:
108+
109+
*
110+
102111
Links
103112
=====
104113

release.rst

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
================
2+
Release Strategy
3+
================
4+
5+
Versioning
6+
==========
7+
8+
- All versions should follow the format of ``MAJOR.MINOR``
9+
- To reduce the maintenance burden, normally we won't do bugfix for non-latest
10+
versions neither release patch versions
11+
- We may have alpha (such ``1.0a0``) or beta (such as ``1.0b0``) versions before
12+
the official release
13+
14+
Publishing
15+
==========
16+
17+
We publishing python packages on PyPI, with "sphinxnotes" prefix, just
18+
access https://pypi.org/search/?q=sphinxnotes to get all of them.
19+
20+
PyPI publishing already `automated with Github Actions`__.
21+
If you want to publish package locally, execute ``make upload`` from the project
22+
root (make sure you have your `API token`__ correctly configured)
23+
24+
__ https://github.com/sphinx-notes/cookiecutter/blob/master/%7B%7Bcookiecutter.name%7D%7D/.github/workflows/release.yml
25+
__ https://pypi.org/help/#apitoken

0 commit comments

Comments
 (0)