1""" 

2Abstract 

3-------- 

4 

5Managing releases in a consistent manner is a strategic strength for any project. Additionally, the ability to maintain 

6release information for both users, developers, and administrators provides essential communication regarding each 

7release of the project and paints a historical picture of the project's progress. 

8 

9Installation 

10------------ 

11 

12Install requirements: 

13 

14.. code-block:: bash 

15 

16 pip install Markdown semver; 

17 

18Add ``superdjango.contrib.release.apps.DefaultConfig`` to ``INSTALLED_APPS``. 

19 

20Optionally configure the following settings: 

21 

22.. code-block:: python 

23 

24 # Markdown extensions for rendering article content. 

25 SUPERDJANGO_RELEASE_PATH = "/path/to/releases/" 

26 

27The default is ``os.path.join(settings.BASE_DIR, "../deploy", "releases")``. 

28 

29Add URLs: 

30 

31.. code-block:: python 

32 

33 urlpatterns = [ 

34 # ... 

35 path('releases/', include(superdjango.contrib.support.urls), 

36 # ... 

37 ] 

38 

39.. note:: 

40 If ``superdjango.contrib.support`` is installed, the release app's views will automatically integrate with the 

41 built-in help site. See the documentation for the support app for install. 

42 

43Usage 

44----- 

45 

46To create a new release: 

47 

48.. code-block:: bash 

49 

50 ./manage.py create_release -m 2 

51 

52Customize the INI files and content files as desired. 

53 

54""" 

55__author__ = "Shawn Davis <shawn@superdjango.com>" 

56__maintainer__ = "Shawn Davis <shawn@superdjango.com>" 

57__version__ = "0.2.0-x"