Commit efcdac7 1 parent 14310dd commit efcdac7 Copy full SHA for efcdac7
File tree 5 files changed +29
-25
lines changed
5 files changed +29
-25
lines changed Original file line number Diff line number Diff line change
1
+ # These are supported funding model platforms
2
+
3
+ open_collective : yeoman
Original file line number Diff line number Diff line change 5
5
- docs
6
6
release :
7
7
types : [published]
8
+ workflow_dispatch :
8
9
9
10
jobs :
10
11
build :
11
12
name : Update api docs
12
13
runs-on : ubuntu-latest
13
14
steps :
14
15
15
- - run : npm install -g jsdoc prettier
16
16
- uses : actions/checkout@v2
17
17
with :
18
18
path : source
19
19
- uses : actions/checkout@v2
20
20
with :
21
21
ref : gh-pages
22
- path : out
22
+ path : yeoman-environment-doc
23
23
- name : Update jsdoc
24
+ working-directory : source
24
25
run : |
25
- cd source
26
26
npm ci
27
- npm install tui-jsdoc-template --no-package-lock
28
- jsdoc -c jsdoc.json -d ../out
29
- - name : Run prettier
30
- run : |
31
- cd out
32
- sed -i -e 's:^[[:space:]]*<!--[[:space:]]*$::g' -e 's:^[[:space:]]*-->[[:space:]]*$::g' global.html
33
- prettier . --write
27
+ npm install tui-jsdoc-template prettier@latest --no-package-lock
28
+ npm run doc
29
+ sed -i -e 's:^[[:space:]]*<!--[[:space:]]*$::g' -e 's:^[[:space:]]*-->[[:space:]]*$::g' ../yeoman-generator-doc/global.html
30
+ npm run doc:prettier
34
31
- name : Create commit
32
+ working-directory : yeoman-environment-doc
35
33
if : always()
36
34
run : |
37
- cd out
38
35
git add .
39
36
git config --local user.email ""
40
37
git config --local user.name "Github Actions"
@@ -46,14 +43,12 @@ jobs:
46
43
with :
47
44
token : ${{ secrets.GITHUB_TOKEN }}
48
45
commit-message : ' Update api for ${{github.event.release.name}}'
49
- committer : " "
50
- author :
Github Actions <[email protected] >
51
46
title : ' Update api for ${{github.event.release.name}}'
52
47
body : |
53
48
Update api docs
54
49
labels : automated pr
55
50
branch : gh-pages-master
56
- path : out
51
+ path : yeoman-environment-doc
57
52
- name : Check outputs
58
53
run : |
59
54
echo "Pull Request Number - ${{ env.PULL_REQUEST_NUMBER }}"
Original file line number Diff line number Diff line change
1
+ node_modules
2
+ .git
3
+ **/scripts/**
4
+ **/styles/**
5
+
Original file line number Diff line number Diff line change 1
1
{
2
+ "source" : {
3
+ "include" : [" readme.md" , " lib" ],
4
+ "includePattern" : " .+\\ .js(doc)?$"
5
+ },
6
+ "opts" : {
7
+ "recurse" : true ,
8
+ "destination" : " ../yeoman-environment-doc" ,
9
+ "template" : " node_modules/tui-jsdoc-template" ,
10
+ "package" : " package.json"
11
+ },
2
12
"templates" : {
3
13
"logo" : {
4
14
"url" : " https://raw.githubusercontent.com/yeoman/yeoman.github.io/source/app/assets/img/logo.png" ,
11
21
"includeDate" : false
12
22
}
13
23
},
14
- "source" : {
15
- "include" : [" readme.md" , " lib" ],
16
- "includePattern" : " .+\\ .js(doc)?$"
17
- },
18
- "opts" : {
19
- "recurse" : true ,
20
- "destination" : " ../out/" ,
21
- "template" : " node_modules/tui-jsdoc-template" ,
22
- "package" : " package.json"
23
- },
24
24
"plugins" : [" plugins/markdown" ]
25
25
}
Original file line number Diff line number Diff line change 36
36
"test-namespace" : " nyc mocha test/namespace.js test/flags.js" ,
37
37
"test-repository" : " nyc mocha test/repository.js" ,
38
38
"test-resolver" : " nyc mocha test/resolver.js" ,
39
- "doc" : " jsdoc -c ./jsdoc.json ./readme.md" ,
39
+ "doc" : " jsdoc -c jsdoc.json -d ../yeoman-environment-doc" ,
40
+ "doc:prettier" : " prettier ../yeoman-environment-doc --write --ignore-path .prettierignore-doc" ,
40
41
"coverage" : " nyc report --reporter=text-lcov | coveralls"
41
42
},
42
43
"dependencies" : {
You can’t perform that action at this time.
0 commit comments