Skip to content

Commit 3219859

Browse files
whitewhite
authored andcommitted
Add social cards plugin and Release Drafter workflow
1 parent ca34302 commit 3219859

4 files changed

Lines changed: 78 additions & 1 deletion

File tree

.github/release-drafter.yml

Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
1+
name-template: 'v$RESOLVED_VERSION'
2+
tag-template: 'v$RESOLVED_VERSION'
3+
4+
categories:
5+
- title: '🚀 Features'
6+
labels:
7+
- 'feature'
8+
- 'enhancement'
9+
- title: '🐛 Bug Fixes'
10+
labels:
11+
- 'fix'
12+
- 'bug'
13+
- title: '📚 Documentation'
14+
labels:
15+
- 'documentation'
16+
- title: '🧰 Maintenance'
17+
labels:
18+
- 'chore'
19+
- 'dependencies'
20+
- 'ci'
21+
22+
change-template: '- $TITLE (#$NUMBER) @$AUTHOR'
23+
24+
version-resolver:
25+
major:
26+
labels:
27+
- 'major'
28+
minor:
29+
labels:
30+
- 'minor'
31+
- 'feature'
32+
patch:
33+
labels:
34+
- 'patch'
35+
- 'fix'
36+
- 'bug'
37+
- 'documentation'
38+
- 'chore'
39+
- 'dependencies'
40+
default: patch
41+
42+
template: |
43+
## What's Changed
44+
45+
$CHANGES
46+
47+
**Full Changelog**: https://github.com/$OWNER/$REPOSITORY/compare/$PREVIOUS_TAG...v$RESOLVED_VERSION

.github/workflows/docs.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ jobs:
2121
python-version: '3.x'
2222

2323
- name: Install dependencies
24-
run: pip install mkdocs-material
24+
run: pip install mkdocs-material pillow cairosvg
2525

2626
- name: Build docs
2727
run: mkdocs build --strict
Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
name: Release Drafter
2+
3+
on:
4+
push:
5+
branches:
6+
- main
7+
workflow_dispatch:
8+
9+
permissions:
10+
contents: write
11+
pull-requests: write
12+
13+
jobs:
14+
update_release_draft:
15+
name: Update Release Draft
16+
runs-on: ubuntu-latest
17+
steps:
18+
- uses: release-drafter/release-drafter@v6
19+
with:
20+
config-name: release-drafter.yml
21+
env:
22+
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

mkdocs.yml

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,12 @@ theme:
2626
- search.highlight
2727
- content.code.copy
2828

29+
plugins:
30+
- social:
31+
cards_layout_options:
32+
font_family: Inter
33+
- search
34+
2935
nav:
3036
- Home: index.md
3137
- Quickstart: quickstart.md
@@ -71,3 +77,5 @@ markdown_extensions:
7177
- pymdownx.emoji:
7278
emoji_index: !!python/name:material.extensions.emoji.twemoji
7379
emoji_generator: !!python/name:material.extensions.emoji.to_svg
80+
- attr_list
81+
- md_in_html

0 commit comments

Comments
 (0)