Skip to content

Commit f2d1faa

Browse files
committed
add: mkdocs example
1 parent 9bfcfe6 commit f2d1faa

File tree

1 file changed

+43
-0
lines changed

1 file changed

+43
-0
lines changed

README.md

Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -69,6 +69,49 @@ action "deploy" {
6969

7070

7171

72+
## Examples
73+
74+
### MkDocs
75+
76+
- [peaceiris/actions-pipenv: GitHub Actions for pipenv](https://github.com/peaceiris/actions-pipenv)
77+
- [main.workflow - peaceiris/mkdocs-material-boilerplate](https://github.com/peaceiris/mkdocs-material-boilerplate/blob/master/.github/main.workflow)
78+
79+
```hcl
80+
workflow "MkDocs workflow" {
81+
on = "push"
82+
resolves = ["deploy"]
83+
}
84+
85+
action "branch-filter" {
86+
uses = "actions/bin/filter@master"
87+
args = "branch master"
88+
}
89+
90+
action "pipenv-sync" {
91+
needs = ["branch-filter"]
92+
uses = "peaceiris/[email protected]"
93+
args = "sync"
94+
}
95+
96+
action "mkdocs-build" {
97+
needs = ["pipenv-sync"]
98+
uses = "peaceiris/[email protected]"
99+
args = ["run", "mkdocs", "build", "--config-file", "./mkdocs-sample.yml"]
100+
}
101+
102+
action "deploy" {
103+
needs = ["mkdocs-build"]
104+
uses = "peaceiris/[email protected]"
105+
env = {
106+
PUBLISH_DIR = "./site"
107+
PUBLISH_BRANCH = "gh-pages"
108+
}
109+
secrets = ["ACTIONS_DEPLOY_KEY"]
110+
}
111+
```
112+
113+
114+
72115
## License
73116

74117
[MIT License - peaceiris/actions-gh-pages]

0 commit comments

Comments
 (0)