Skip to content
New issue

Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? # to your account

docs: fix incorrect github action examples and align with official gi… #430

Merged
merged 1 commit into from
Jun 26, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions Taskfile.yml
Original file line number Diff line number Diff line change
Expand Up @@ -54,3 +54,8 @@ tasks:
desc: Delete all artefacts from recent build
cmds:
- rm -f ./{{.BINNAME}}

docs:
desc: Builds and hosts the MkDocs documentation
cmds:
- docker run --rm -it -p 8000:8000 -v $PWD:/docs squidfunk/mkdocs-material
4 changes: 2 additions & 2 deletions docs/changelog.md
Original file line number Diff line number Diff line change
Expand Up @@ -67,5 +67,5 @@ uplift changelog --skip-prerelease
Trims any lines preceding the conventional commit type in the commit message

```sh
uplift changelog --skip-prerelease
```
uplift changelog --trim-header
```
9 changes: 7 additions & 2 deletions docs/ci/github.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,10 +19,12 @@ jobs:
uses: actions/checkout@v3
with:
fetch-depth: 0 # (1)

# Additional steps specified here

- name: Release
if: github.ref == 'refs/heads/main'
uses: gembaadvantage/uplift-action@v2.0.1
uses: gembaadvantage/uplift-action@v2
with:
args: release
env:
Expand Down Expand Up @@ -53,10 +55,13 @@ jobs:
uses: actions/checkout@v3
with:
fetch-depth: 0
token: ${{ secrets.GH_UPLIFT }}

# Additional steps specified here

- name: Release
if: github.ref == 'refs/heads/main'
uses: gembaadvantage/uplift-action@v2.0.1
uses: gembaadvantage/uplift-action@v2
with:
args: release
env:
Expand Down
4 changes: 2 additions & 2 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -118,8 +118,8 @@ markdown_extensions:
- pymdownx.caret
- pymdownx.critic
- pymdownx.emoji:
emoji_generator: !!python/name:materialx.emoji.to_svg
emoji_index: !!python/name:materialx.emoji.twemoji
emoji_index: !!python/name:material.extensions.emoji.twemoji
emoji_generator: !!python/name:material.extensions.emoji.to_svg
- pymdownx.highlight:
anchor_linenums: true
- pymdownx.inlinehilite
Expand Down