docs: fixes few things (#4249)

This commit is contained in:
Kevin Schlosser
2023-05-29 02:46:42 -06:00
committed by GitHub
parent 42d24403c3
commit 236c1e0c73
7 changed files with 307 additions and 1000 deletions

View File

@@ -1,122 +1,149 @@
{{#each releases}}
`{{title}} <{{href}}>`__ {{niceDate}}
---------------------------------------------------------------------------------------------------
---------------------------------------------------------------------------------------------------------------------------------------------------
Breaking Changes
~~~~~~~~~~~~~~~~
{{#commit-list merges heading='' message='BREAKING CHANGE'}}
- .. warning: {{message}} `{{id}} <{{href}}>`__
- .. warning: {{message}}
`{{id}} <{{href}}>`__
{{/commit-list}}
{{#commit-list commits heading='' message='BREAKING CHANGE'}}
- .. warning: {{subject}} `{{shorthash}} <{{href}}>`__
- .. warning: {{subject}}
`{{shorthash}} <{{href}}>`__
{{/commit-list}}
{{#commit-list fixes heading='' message='BREAKING CHANGE'}}
- **{{commit.subject}}** `{{commit.shorthash}} <{{commit.href}}>`__
- **{{commit.subject}}**
`{{commit.shorthash}} <{{commit.href}}>`__
{{/commit-list}}
Architectural
~~~~~~~~~~~~~
{{#commit-list merges heading='' message='^arch' exclude='BREAKING CHANGE'}}
- **{{message}}** `{{id}} <{{href}}>`__
- **{{message}}**
`{{id}} <{{href}}>`__
{{/commit-list}}
{{#commit-list commits heading='' message='^arch' exclude='BREAKING CHANGE'}}
- **{{subject}}** `{{shorthash}} <{{href}}>`__
- **{{subject}}**
`{{shorthash}} <{{href}}>`__
{{/commit-list}}
{{#commit-list fixes heading='' message='^arch' exclude='BREAKING CHANGE'}}
- **{{commit.subject}}** `{{commit.shorthash}} <{{commit.href}}>`__
- **{{commit.subject}}**
`{{commit.shorthash}} <{{commit.href}}>`__
{{/commit-list}}
New Features
~~~~~~~~~~~~
{{#commit-list merges heading='' message='^feat' exclude='BREAKING CHANGE'}}
- **{{message}}** `{{id}} <{{href}}>`__
- **{{message}}**
`{{id}} <{{href}}>`__
{{/commit-list}}
{{#commit-list commits heading='' message='^feat' exclude='BREAKING CHANGE'}}
- **{{subject}}** `{{shorthash}} <{{href}}>`__
- **{{subject}}**
`{{shorthash}} <{{href}}>`__
{{/commit-list}}
{{#commit-list fixes heading='' message='^feat' exclude='BREAKING CHANGE'}}
- **{{commit.subject}}** `{{commit.shorthash}} <{{commit.href}}>`__
- **{{commit.subject}}**
`{{commit.shorthash}} <{{commit.href}}>`__
{{/commit-list}}
Performance
~~~~~~~~~~~
{{#commit-list merges heading='' message='^perf' exclude='BREAKING CHANGE'}}
- **{{message}}** `{{id}} <{{href}}>`__
- **{{message}}**
`{{id}} <{{href}}>`__
{{/commit-list}}
{{#commit-list commits heading='' message='^perf' exclude='BREAKING CHANGE'}}
- **{{subject}}** `{{shorthash}} <{{href}}>`__
- **{{subject}}**
`{{shorthash}} <{{href}}>`__
{{/commit-list}}
{{#commit-list fixes heading='' message='^perf' exclude='BREAKING CHANGE'}}
- **{{commit.subject}}** `{{commit.shorthash}} <{{commit.href}}>`__
- **{{commit.subject}}**
`{{commit.shorthash}} <{{commit.href}}>`__
{{/commit-list}}
Fixes
~~~~~
{{#commit-list merges heading='' message='^fix' exclude='(^fix conflict|^fix warning|BREAKING CHANGE)'}}
- **{{message}}** `{{id}} <{{href}}>`__
- **{{message}}**
`{{id}} <{{href}}>`__
{{/commit-list}}
{{#commit-list commits heading='' message='^fix' exclude='(^fix conflict|^fix warning|BREAKING CHANGE)'}}
- **{{subject}}** `{{shorthash}} <{{href}}>`__
- **{{subject}}**
`{{shorthash}} <{{href}}>`__
{{/commit-list}}
{{#commit-list fixes heading='' message='^fix' exclude='(^fix conflict|^fix warning|BREAKING CHANGE)'}}
- **{{commit.subject}}** `{{commit.shorthash}} <{{commit.href}}>`__
- **{{commit.subject}}**
`{{commit.shorthash}} <{{commit.href}}>`__
{{/commit-list}}
Examples
~~~~~~~~
{{#commit-list merges heading='' message='^example'}}
- **{{message}}** `{{id}} <({{href}})>`__
- **{{message}}**
`{{id}} <({{href}})>`__
{{/commit-list}}
{{#commit-list commits heading='' message='^example'}}
- **{{subject}}** `{{shorthash}} <{{href}}>`__
- **{{subject}}**
`{{shorthash}} <{{href}}>`__
{{/commit-list}}
{{#commit-list fixes heading='' message='^example'}}
- **{{commit.subject}}** `{{commit.shorthash}} <{{commit.href}}>`__
- **{{commit.subject}}**
`{{commit.shorthash}} <{{commit.href}}>`__
{{/commit-list}}
Docs
~~~~
{{#commit-list merges heading='' message='^docs'}}
- **{{message}}** `{{id}} <{{href}}>`__
- **{{message}}**
`{{id}} <{{href}}>`__
{{/commit-list}}
{{#commit-list commits heading='' message='^docs'}}
- **{{subject}}** `{{shorthash}} <{{href}}>`__
- **{{subject}}**
`{{shorthash}} <{{href}}>`__
{{/commit-list}}
{{#commit-list fixes heading='' message='^docs'}}
- **{{commit.subject}}** `{{commit.shorthash}} <{{commit.href}}>`__
- **{{commit.subject}}**
`{{commit.shorthash}} <{{commit.href}}>`__
{{/commit-list}}
CI and tests
~~~~~~~~~~~~
{{#commit-list merges heading='' message='(^ci|^test)'}}
- **{{message}}** `{{id}} <{{href}}>`__
- **{{message}}**
`{{id}} <{{href}}>`__
{{/commit-list}}
{{#commit-list commits heading='' message='(^ci|^test)'}}
- **{{subject}}** `{{shorthash }} <{{href}}>`__
- **{{subject}}**
`{{shorthash }} <{{href}}>`__
{{/commit-list}}
{{#commit-list fixes heading='' message='(^ci|^test)'}}
- **{{commit.subject}}** `{{commit.shorthash}} <{{commit.href}}>`__
- **{{commit.subject}}**
`{{commit.shorthash}} <{{commit.href}}>`__
{{/commit-list}}
Others
~~~~~~
{{#commit-list merges heading='' exclude='(^fix|^feat|^perf|^docs|^example|^ci|^test)'}}
- **{{message}}** `{{id }} <{{href}}>`__
- **{{message}}**
`{{id }} <{{href}}>`__
{{/commit-list}}
{{#commit-list commits heading='' exclude='(^fix|^feat|^perf|^docs|^example|^ci|^test)'}}
- **{{subject}}** `{{shorthash }} <{{href}}>`__
- **{{subject}}**
`{{shorthash }} <{{href}}>`__
{{/commit-list}}
{{#commit-list fixes heading='' exclude='(^fix|^feat|^perf|^docs|^example|^ci|^test)'}}
- **{{commit.subject}}** `{{commit.shorthash}} <{{commit.href}}>`__
- **{{commit.subject}}**
`{{commit.shorthash}} <{{commit.href}}>`__
{{/commit-list}}
{{/each}}