Skip to content

Commit 59f994d

Browse files
committed
Update gh-pages build setup
1 parent 6f70eda commit 59f994d

File tree

7 files changed

+44
-21
lines changed

7 files changed

+44
-21
lines changed

.github/workflows/ci-docs.yaml

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -16,23 +16,23 @@ jobs:
1616

1717
steps:
1818
- name: Checkout code
19-
uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0
19+
uses: actions/checkout@v5
2020
with:
2121
submodules: 'recursive'
2222

2323
- name: Set up Hugo
24-
uses: peaceiris/actions-hugo@6e295a6a0c9087bf374299e9d67f9d2edab9f18f # v3.0.0
24+
uses: peaceiris/actions-hugo@v3
2525
with:
2626
hugo-version: 'latest'
2727
extended: true
2828

2929
- name: Set up Node
30-
uses: actions/setup-node@a0853c24544627f65ddf259abe73b1d18a591444 # v5.0.0
30+
uses: actions/setup-node@v5
3131
with:
3232
node-version: 20
3333

34-
- name: Set up PostCSS
35-
run: npm install --save-dev autoprefixer postcss-cli postcss
34+
- name: Install dependencies
35+
run: npm ci
3636

3737
- name: Build
3838
run: hugo

.github/workflows/publish-docs.yaml

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -15,33 +15,33 @@ jobs:
1515

1616
steps:
1717
- name: Checkout code
18-
uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0
18+
uses: actions/checkout@v5
1919
with:
2020
submodules: 'recursive'
2121

2222
- name: Set up Pages
2323
id: pages
24-
uses: actions/configure-pages@983d7736d9b0ae728b81ab479565c72886d7745b # v5.0.0
24+
uses: actions/configure-pages@v5
2525

2626
- name: Set up Hugo
27-
uses: peaceiris/actions-hugo@6e295a6a0c9087bf374299e9d67f9d2edab9f18f # v3.0.0
27+
uses: peaceiris/actions-hugo@v3
2828
with:
2929
hugo-version: 'latest'
3030
extended: true
3131

3232
- name: Set up Node
33-
uses: actions/setup-node@a0853c24544627f65ddf259abe73b1d18a591444 # v5.0.0
33+
uses: actions/setup-node@v5
3434
with:
3535
node-version: 20
3636

37-
- name: Set up PostCSS
38-
run: npm install --save-dev autoprefixer postcss-cli postcss
37+
- name: Install dependencies
38+
run: npm ci
3939

4040
- name: Build
41-
run: hugo --environment production --baseURL ${{ steps.pages.outputs.base_url }}/
41+
run: hugo --environment production --gc --minify --baseURL ${{ steps.pages.outputs.base_url }}/
4242

4343
- name: Upload artifact
44-
uses: actions/upload-pages-artifact@7b1f4a764d45c48632c6b24a0339c27f5614fb0b # v4.0.0
44+
uses: actions/upload-pages-artifact@v4
4545
with:
4646
path: ./public/
4747

@@ -66,4 +66,4 @@ jobs:
6666
steps:
6767
- name: Deploy to GitHub Pages
6868
id: deployment
69-
uses: actions/deploy-pages@d6db90164ac5ed86f2b6aed7e0febac5b3c0c03e # v4.0.5
69+
uses: actions/deploy-pages@v4

.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,7 @@ tmp/
77
bin/
88
scripts/__pycache__/
99
node_modules/
10+
package-lock.json
1011
*.swp
1112
*~
1213
.hugo_build.lock

config/_default/config.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11

22
title = "Koperator"
33

4-
#theme = ["docsy"]
4+
# theme = ["docsy"] # Using Hugo modules instead
55

66
baseurl = "https://opensource.adobe.com/koperator/"
77

go.mod

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,8 @@
1-
module github.com/openclarity/docs.openclarity.io
1+
module github.com/adobe/koperator-docs
22

33
go 1.24
44

55
require (
6-
github.com/FortAwesome/Font-Awesome v0.0.0-20241216213156-af620534bfc3 // indirect
76
github.com/google/docsy v0.12.0 // indirect
87
github.com/google/docsy/dependencies v0.7.2 // indirect
9-
github.com/twbs/bootstrap v5.3.8+incompatible // indirect
108
)

go.sum

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,8 @@
11
github.com/FortAwesome/Font-Awesome v0.0.0-20230327165841-0698449d50f2/go.mod h1:IUgezN/MFpCDIlFezw3L8j83oeiIuYoj28Miwr/KUYo=
2-
github.com/FortAwesome/Font-Awesome v0.0.0-20241216213156-af620534bfc3 h1:/iluJkJiyTAdnqrw3Yi9rH2HNHhrrtCmj8VJe7I6o3w=
32
github.com/FortAwesome/Font-Awesome v0.0.0-20241216213156-af620534bfc3/go.mod h1:IUgezN/MFpCDIlFezw3L8j83oeiIuYoj28Miwr/KUYo=
43
github.com/google/docsy v0.12.0 h1:CddZKL39YyJzawr8GTVaakvcUTCJRAAYdz7W0qfZ2P4=
54
github.com/google/docsy v0.12.0/go.mod h1:1bioDqA493neyFesaTvQ9reV0V2vYy+xUAnlnz7+miM=
65
github.com/google/docsy/dependencies v0.7.2 h1:+t5ufoADQAj4XneFphz4A+UU0ICAxmNaRHVWtMYXPSI=
76
github.com/google/docsy/dependencies v0.7.2/go.mod h1:gihhs5gmgeO+wuoay4FwOzob+jYJVyQbNaQOh788lD4=
87
github.com/twbs/bootstrap v5.2.3+incompatible/go.mod h1:fZTSrkpSf0/HkL0IIJzvVspTt1r9zuf7XlZau8kpcY0=
98
github.com/twbs/bootstrap v5.3.6+incompatible/go.mod h1:fZTSrkpSf0/HkL0IIJzvVspTt1r9zuf7XlZau8kpcY0=
10-
github.com/twbs/bootstrap v5.3.8+incompatible h1:eK1fsXP7R/FWFt+sSNmmvUH9usPocf240nWVw7Dh02o=
11-
github.com/twbs/bootstrap v5.3.8+incompatible/go.mod h1:fZTSrkpSf0/HkL0IIJzvVspTt1r9zuf7XlZau8kpcY0=

package.json

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
{
2+
"name": "koperator-docs",
3+
"version": "1.0.0",
4+
"description": "Documentation site for Koperator",
5+
"main": "index.js",
6+
"scripts": {
7+
"build": "hugo --gc --minify",
8+
"serve": "hugo server --buildDrafts --buildFuture",
9+
"test": "echo \"Error: no test specified\" && exit 1"
10+
},
11+
"repository": {
12+
"type": "git",
13+
"url": "git+https://github.com/adobe/koperator.git"
14+
},
15+
"keywords": [
16+
"hugo",
17+
"documentation",
18+
"koperator"
19+
],
20+
"author": "Adobe",
21+
"license": "Apache-2.0",
22+
"devDependencies": {
23+
"autoprefixer": "^10.4.16",
24+
"postcss": "^8.4.32",
25+
"postcss-cli": "^11.0.0"
26+
}
27+
}

0 commit comments

Comments
 (0)