用于呈现github项目属性的jinja2扩展
jinja2-github的Python项目详细描述
用于呈现github项目属性的jinja2扩展。
可用的扩展名如下:
- github_repo_branch_sha:呈现与 github项目分支。
- github_repo_description:呈现github项目的描述。
用法
Github回购分行SHA标签
扩展名带有一个github_repo_branch_sha标记,该标记允许 呈现与github项目分支关联的最后一个提交sha。
默认情况下,使用master分支。
fromjinja2importEnvironmentenv=Environment(extensions=['jinja2_github.GitHubRepoBranchShaExtension'])# Default branch is master -> "4f5191b50026f7281ca1b1cd180e05fad1d716c6"template=env.from_string("{% github_repo_branch_sha 'Slicer/Slicer' %}")template.render()
也可以指定分支(或标记)名称:
fromjinja2importEnvironmentenv=Environment(extensions=['jinja2_github.GitHubRepoBranchShaExtension'])# With an explicit branch name -> "cfe12ceefd761502181660de76a8cc5d40d5f31c"template=env.from_string("{% github_repo_branch_sha 'Slicer/Slicer', 'master-48' %}")template.render()
Github回购说明
扩展名带有一个github_repo_description标记,该标记允许 呈现github项目的描述。
fromjinja2importEnvironmentenv=Environment(extensions=['jinja2_github.GitHubRepoDescriptionExtension'])# -> "Multi-platform, free open source software for visualization and image computing."template=env.from_string("{% github_repo_description 'Slicer/Slicer' %}")template.render()
问题
如果您遇到任何问题,请file an issue连同详细说明。
维护者:发布
- 确保所有的ci测试都通过了CircleCI。
- 列出按版本排序的所有标记
$ git tag -l | sort -V
- 选择下一版本号
$ release=X.Y.ZWarning
To ensure the packages are uploaded on PyPI, tags must match this regular expression: ^{tt6}$.
- 下载最新来源
$ cd /tmp && \ git clone git@github.com:jcfr/jinja2-github && \ cd jinja2-github
- 在jinja2_github.py脚本中更新__version__。
$ sed -i "5s/.*/__version__ = '$release'/" jinja2_github.py
- 提交并推动更改
$ git add jinja2_github.py $ git commit -m "jinja2-github $release" $ git push origin master
- 标记释放装置
$ git tag --sign -m "jinja2-github ${release}" ${release} origin/masterNote
We recommend using a GPG signing key to sign the tag.
- 发布发布标记
$ git push origin ${release}Important
This will trigger builds on each CI services and automatically upload the wheels and source distribution on PyPI.
行为准则
在Jinja2 GitHub项目的代码库中进行交互的每个人,问题跟踪器,聊天 房间和邮件列表应遵循PyPA Code of Conduct。