Coverage for src/lcdoc/mkdocs/lp/plugs/python/pyplugs/git_changelog/__init__.py: 76.04%

1""" 

2## Changelog 

3 

4Creates CHANGELOG.md (using git-changelog) 

5 

6File: `<project root>/CHANGELOG.md`. Reference in docs like: 

7 

8```bash 

9~/repos/docutools❯ cat docs/about/changelog.md 

10\{\!CHANGELOG.md!} 

11``` 

12 

13(without the backslashes) 

14 

15 

16### Templates 

17 

18Links default jinja templates over to docs/lcd/changelog. 

19In order to use your own, overwrite that directory. 

20 

21 

22### Config 

23 

24```python 

25 style = Choice(['angular', 'basic', 'atom'], default='angular') 

26 versioning = Choice(['auto', 'semver', 'calver'], default='auto') 

27``` 

28 

29when set to auto we derive by inspecting your last git tag - if like X.foo.bar with X a 

30number > 2000 we set to calver. 

31 

32You can set $versioning also via environ, which will have precedence then. 

33 

34""" 

35import shutil 1 ctxlp|index.md

36 

37from mkdocs.config import config_options 1 ctxlp|index.md

38 

39import lcdoc 1 ctxlp|index.md

40from lcdoc.mkdocs import markdown 1 ctxlp|index.md

41from lcdoc.mkdocs.lp.plugs import python 1 ctxlp|index.md

42from lcdoc.mkdocs.tools import MDPlugin, app, link_assets 1 ctxlp|index.md

43from lcdoc.tools import dirname, os, project, read_file, write_file 1 ctxlp|index.md

44 

45config, page, Session, lpkw = (python.config, python.page, python.Session, python.lpkw) 1 ctxlp|index.md

46 

47formatted = True 1 ctxlp|index.md

48 

49 

50def latest_ver(changelog): 1 ctxlp|index.md

51 # depends on presence of 'Compare with' within the templates 

52 try: 1 ctxlp|about/changelog.md

53 return changelog.split('Compare with', 1)[1].split('\n', 1)[0].split(']', 1)[0] 1 ctxlp|about/changelog.md

54 except Exception as exc: 

55 msg = 'Not able to extract latest ver' 

56 app.warn(msg, exc=exc) 

57 return msg 

58 

59 

60def git_changelog(commit_style, d_root, d_tmpl): 1 ctxlp|index.md

61 """A version of git-changelog monkey patched, so that versions have zero padded 

62 months and days replaced to non zero padded versions 

63 

64 Otherwise the semver lib would complain about non-compliancy.  

65 """ 

66 argv = ['-s', commit_style, '-t', 'path:%s' % d_tmpl, d_root] 1 ctxlp|about/changelog.md

67 from git_changelog import build 1 ctxlp|about/changelog.md

68 

69 # monkey patched bump function: 

70 bmp = lambda v, p, b: b(v.replace('.0', '.'), p) 70 ↛ exitline 70 didn't run the lambda on line 701 ctxlp|about/changelog.md

71 build.bump = lambda version, part='patch', b=build.bump: bmp(version, part, b) 71 ↛ exitline 71 didn't run the lambda on line 711 ctxlp|about/changelog.md

72 from git_changelog import cli 1 ctxlp|about/changelog.md

73 from io import StringIO 1 ctxlp|about/changelog.md

74 from contextlib import redirect_stdout 1 ctxlp|about/changelog.md

75 

76 c = StringIO() 1 ctxlp|about/changelog.md

77 with redirect_stdout(c): 1 ctxlp|about/changelog.md

78 cli.main(argv) 1 ctxlp|about/changelog.md

79 cl = c.getvalue() 1 ctxlp|about/changelog.md

80 app.info('changelog created', latest=latest_ver(cl)) 1 ctxlp|about/changelog.md

81 return cl 1 ctxlp|about/changelog.md

82 

83 

84def gen_change_log(d_assets, versioning_scheme, commit_style): 1 ctxlp|index.md

85 """ 

86 Problem: The git-changelog cmd uses Jinja and wants .md 

87 mkdocs macros also, different contexts though -> crash. 

88 So we cannot have .md sources in the docs folder -> have to change on the fly when 

89 using git-changelog. Here we do that. Also we dyn set the versioning message. 

90 """ 

91 dr = project.root(config()) 1 ctxlp|about/changelog.md

92 d, dtmp = (dirname, dr + '/build/git_changelog_tmpl') 1 ctxlp|about/changelog.md

93 

94 def set_version_scheme(fn, ver): 1 ctxlp|about/changelog.md

95 # todo: do it in jinaja in the template itself: 

96 CV = 'This project adheres to [CalVer Versioning](http://calver.org) ' 1 ctxlp|about/changelog.md

97 CV += '.' 1 ctxlp|about/changelog.md

98 SV = 'This project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).' 1 ctxlp|about/changelog.md

99 VSM = CV if ver == 'calver' else SV 1 ctxlp|about/changelog.md

100 s = read_file(fn).replace('_VERSION_SCHEME_MSG_', VSM) 1 ctxlp|about/changelog.md

101 write_file(fn, s) 1 ctxlp|about/changelog.md

102 

103 dcl = d_assets + '/keepachangelog' 1 ctxlp|about/changelog.md

104 os.makedirs(dtmp, exist_ok=True) 1 ctxlp|about/changelog.md

105 ver = versioning_scheme 1 ctxlp|about/changelog.md

106 if ver == 'auto': 106 ↛ 107line 106 didn't jump to line 107, because the condition on line 106 was never true1 ctxlp|about/changelog.md

107 hint = 'export $versioning or set "versioning" in mkdocs plugin config ' 

108 hint += 'to calver or semver' 

109 gt = os.popen('cd "%s" && git tag | tail -n 1' % dr).read().strip() 

110 if not gt: 

111 app.die('Cannot derive versioning scheme, no git tags yet', hint=hint) 

112 ver = 'semver' 

113 try: 

114 if int(gt.split('.', 1)[0]) > 2000: 

115 ver = 'calver' 

116 except: 

117 pass 

118 app.info('Versioning derived from git tags', versioning=ver) 

119 

120 # '/home/gk/repos/docutools/docs/lcd/git_changelog/keepachangelog' 

121 for k in os.listdir(dcl): 1 ctxlp|about/changelog.md

122 fn = dtmp + '/' + k.replace('.tmpl', '') 1 ctxlp|about/changelog.md

123 shutil.copyfile(dcl + '/' + k, fn) 1 ctxlp|about/changelog.md

124 if k == 'changelog.md.tmpl': 1 ctxlp|about/changelog.md

125 set_version_scheme(fn, ver) 1 ctxlp|about/changelog.md

126 return git_changelog(commit_style, dr, dtmp) 1 ctxlp|about/changelog.md

127 

128 

129def register(fmts): 1 ctxlp|index.md

130 fmts['git_changelog'] = make_changelog 1 ctxlp|index.md

131 

132 

133def g(key, dflt, *l): 1 ctxlp|index.md

134 for d in l: 1 ctxlp|about/changelog.md

135 v = d.get(key) 1 ctxlp|about/changelog.md

136 if v: 1 ctxlp|about/changelog.md

137 return v 1 ctxlp|about/changelog.md

138 return dflt 1 ctxlp|about/changelog.md

139 

140 

141def make_changelog(s, **show_kw): 1 ctxlp|index.md

142 l = (show_kw, lpkw(), os.environ) 1 ctxlp|about/changelog.md

143 style = g('commit_style', 'angular', *l) 1 ctxlp|about/changelog.md

144 ver = g('versioning', 'semver', *l) 1 ctxlp|about/changelog.md

145 d_assets = link_assets(python, __file__, config()) 1 ctxlp|about/changelog.md

146 os.system('ls docs/lcd/git_changelog') 1 ctxlp|about/changelog.md

147 

148 r = gen_change_log(d_assets, ver, style) 1 ctxlp|about/changelog.md

149 return r 1 ctxlp|about/changelog.md