Skip to content

Commit 222fc1b

Browse files
VaclavEliasVaclavElias
authored
Merge pull request #482 from stride3d/master
Deploy latest documentation updates to production
2 parents 0167f84 + 06d8644 commit 222fc1b

46 files changed

Lines changed: 1501 additions & 638 deletions

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎.github/workflows/common-setup.yml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -46,4 +46,4 @@ jobs:
4646
# This installs the latest version of DocFX and may introduce breaking changes
4747
# run: dotnet tool update -g docfx
4848
# This installs a specific, tested version of DocFX.
49-
run: dotnet tool update -g docfx --version 2.78.3
49+
run: dotnet tool update -g docfx --version 2.78.3

‎.github/workflows/stride-docs-github.yml‎

Lines changed: 37 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -16,13 +16,13 @@ jobs:
1616

1717
steps:
1818
- name: .NET SDK Setup
19-
uses: actions/setup-dotnet@v4
19+
uses: actions/setup-dotnet@v5
2020
with:
2121
dotnet-version: 10.x
2222

2323
# Checkout the Stride Docs repository from the branch that triggered the workflow
2424
- name: Checkout Stride Docs
25-
uses: actions/checkout@v5
25+
uses: actions/checkout@v6
2626
with:
2727
path: ${{ env.DOCS_PATH }}
2828
lfs: true
@@ -36,26 +36,56 @@ jobs:
3636

3737
# Checkout the Stride repository from the default branch
3838
- name: Checkout Stride (note the LFS)
39-
uses: actions/checkout@v5
39+
uses: actions/checkout@v6
4040
with:
4141
repository: stride3d/stride
4242
token: ${{ secrets.GITHUB_TOKEN }}
4343
path: stride
4444
lfs: true
45+
ref: master
46+
47+
# Temporary solution till the new docfx is available
48+
# - name: Checkout DocFX
49+
# uses: actions/checkout@v6
50+
# with:
51+
# repository: dotnet/docfx
52+
# # Tested commit
53+
# ref: 917cda864650279e0bbe50b852cb98601e5efa4d
54+
# path: docfx-build
55+
# fetch-depth: 0
56+
57+
# - name: Restore npm dependencies
58+
# run: npm install
59+
# working-directory: docfx-build/templates
60+
61+
# - name: Build site templates
62+
# run: npm run build
63+
# working-directory: docfx-build/templates
64+
65+
# - name: Build DocFX from PR
66+
# run: dotnet pack src/docfx -c Release /p:Version=2.9-stride -o drop/nuget
67+
# working-directory: docfx-build
68+
# shell: pwsh
69+
70+
# - name: Build Install DocFX
71+
# run: dotnet tool install -g docfx --version 2.9-stride --add-source drop/nuget
72+
# working-directory: docfx-build
73+
# shell: pwsh
74+
# End of Temporary solution
4575

4676
- name: Install DocFX
4777
# This installs the latest version of DocFX and may introduce breaking changes
4878
# run: dotnet tool update -g docfx
4979
# This installs a specific, tested version of DocFX.
50-
run: dotnet tool update -g docfx --version 2.78.3
80+
run: dotnet tool update -g docfx --version 2.78.5
5181

5282
- name: Build documentation
53-
run: ./build-all.bat
83+
run: ./build-all-skip-pdf.bat
5484
working-directory: ${{ env.DOCS_PATH }}
5585

5686
- name: Deploy
57-
uses: peaceiris/actions-gh-pages@v3.9.2
87+
uses: peaceiris/actions-gh-pages@v4
5888
with:
5989
github_token: ${{ secrets.GITHUB_TOKEN }}
6090
publish_dir: ${{ env.DOCS_PATH }}/_site
61-
publish_branch: gh-pages
91+
publish_branch: gh-pages

‎.github/workflows/stride-docs-release-azure.yml‎

Lines changed: 35 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -32,13 +32,13 @@ jobs:
3232

3333
steps:
3434
- name: .NET SDK Setup
35-
uses: actions/setup-dotnet@v4
35+
uses: actions/setup-dotnet@v5
3636
with:
3737
dotnet-version: 10.x
3838

3939
# Checkout the Stride Docs repository from the branch that triggered the workflow
4040
- name: Checkout Stride Docs
41-
uses: actions/checkout@v5
41+
uses: actions/checkout@v6
4242
with:
4343
path: ${{ env.DOCS_PATH }}
4444
lfs: true
@@ -52,7 +52,7 @@ jobs:
5252

5353
# Checkout the Stride repository from the default branch
5454
- name: Checkout Stride (note the LFS)
55-
uses: actions/checkout@v5
55+
uses: actions/checkout@v6
5656
with:
5757
repository: stride3d/stride
5858
token: ${{ secrets.GITHUB_TOKEN }}
@@ -61,37 +61,39 @@ jobs:
6161
ref: master
6262

6363
# Temporary solution till the new docfx is available
64-
- name: Checkout DocFX PR Branch
65-
uses: actions/checkout@v5
66-
with:
67-
repository: filzrev/docfx
68-
ref: feat-add-net10-support
69-
path: docfx-build
70-
71-
- name: Restore npm dependencies
72-
run: npm install
73-
working-directory: docfx-build/templates
74-
75-
- name: Build site templates
76-
run: npm run build
77-
working-directory: docfx-build/templates
78-
79-
- name: Build DocFX from PR
80-
run: dotnet pack src/docfx -c Release /p:Version=2.9-stride -o drop/nuget
81-
working-directory: docfx-build
82-
shell: pwsh
83-
84-
- name: Build Install DocFX
85-
run: dotnet tool install -g docfx --version 2.9-stride --add-source drop/nuget
86-
working-directory: docfx-build
87-
shell: pwsh
88-
# End of Temporary solution
89-
90-
#- name: Install DocFX
64+
# - name: Checkout DocFX
65+
# uses: actions/checkout@v6
66+
# with:
67+
# repository: dotnet/docfx
68+
# # Tested commit
69+
# ref: 917cda864650279e0bbe50b852cb98601e5efa4d
70+
# path: docfx-build
71+
# fetch-depth: 0
72+
73+
# - name: Restore npm dependencies
74+
# run: npm install
75+
# working-directory: docfx-build/templates
76+
77+
# - name: Build site templates
78+
# run: npm run build
79+
# working-directory: docfx-build/templates
80+
81+
# - name: Build DocFX from PR
82+
# run: dotnet pack src/docfx -c Release /p:Version=2.9-stride -o drop/nuget
83+
# working-directory: docfx-build
84+
# shell: pwsh
85+
86+
# - name: Build Install DocFX
87+
# run: dotnet tool install -g docfx --version 2.9-stride --add-source drop/nuget
88+
# working-directory: docfx-build
89+
# shell: pwsh
90+
# End of Temporary solution
91+
92+
- name: Install DocFX
9193
# This installs the latest version of DocFX and may introduce breaking changes
9294
# run: dotnet tool update -g docfx
9395
# This installs a specific, tested version of DocFX.
94-
#run: dotnet tool update -g docfx --version 2.78.3
96+
run: dotnet tool update -g docfx --version 2.78.5
9597

9698
- name: Build documentation
9799
run: ./build-all.bat
@@ -101,7 +103,7 @@ jobs:
101103
run: 7z a -r DocFX-app.zip ./${{ env.DOCS_PATH }}/_site/*
102104

103105
- name: Upload artifact for deployment job
104-
uses: actions/upload-artifact@v5
106+
uses: actions/upload-artifact@v6
105107
with:
106108
name: DocFX-app
107109
path: DocFX-app.zip
@@ -124,7 +126,7 @@ jobs:
124126

125127
steps:
126128
- name: Download artifact from build job
127-
uses: actions/download-artifact@v6
129+
uses: actions/download-artifact@v7
128130
with:
129131
name: DocFX-app
130132

‎.github/workflows/stride-docs-release-fast-track-azure.yml‎

Lines changed: 33 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -26,13 +26,13 @@ jobs:
2626

2727
steps:
2828
- name: .NET SDK Setup
29-
uses: actions/setup-dotnet@v4
29+
uses: actions/setup-dotnet@v5
3030
with:
3131
dotnet-version: 10.x
3232

3333
# Checkout the Stride Docs repository from the branch that triggered the workflow
3434
- name: Checkout Stride Docs
35-
uses: actions/checkout@v5
35+
uses: actions/checkout@v6
3636
with:
3737
path: ${{ env.DOCS_PATH }}
3838
lfs: true
@@ -46,7 +46,7 @@ jobs:
4646

4747
# Checkout the Stride repository from the default branch
4848
- name: Checkout Stride (note the LFS)
49-
uses: actions/checkout@v5
49+
uses: actions/checkout@v6
5050
with:
5151
repository: stride3d/stride
5252
token: ${{ secrets.GITHUB_TOKEN }}
@@ -55,37 +55,39 @@ jobs:
5555
ref: master
5656

5757
# Temporary solution till the new docfx is available
58-
- name: Checkout DocFX PR Branch
59-
uses: actions/checkout@v5
60-
with:
61-
repository: filzrev/docfx
62-
ref: feat-add-net10-support
63-
path: docfx-build
64-
65-
- name: Restore npm dependencies
66-
run: npm install
67-
working-directory: docfx-build/templates
68-
69-
- name: Build site templates
70-
run: npm run build
71-
working-directory: docfx-build/templates
72-
73-
- name: Build DocFX from PR
74-
run: dotnet pack src/docfx -c Release /p:Version=2.9-stride -o drop/nuget
75-
working-directory: docfx-build
76-
shell: pwsh
77-
78-
- name: Build Install DocFX
79-
run: dotnet tool install -g docfx --version 2.9-stride --add-source drop/nuget
80-
working-directory: docfx-build
81-
shell: pwsh
82-
# End of Temporary solution
83-
84-
#- name: Install DocFX
58+
# - name: Checkout DocFX
59+
# uses: actions/checkout@v6
60+
# with:
61+
# repository: dotnet/docfx
62+
# # Tested commit
63+
# ref: 917cda864650279e0bbe50b852cb98601e5efa4d
64+
# path: docfx-build
65+
# fetch-depth: 0
66+
67+
# - name: Restore npm dependencies
68+
# run: npm install
69+
# working-directory: docfx-build/templates
70+
71+
# - name: Build site templates
72+
# run: npm run build
73+
# working-directory: docfx-build/templates
74+
75+
# - name: Build DocFX from PR
76+
# run: dotnet pack src/docfx -c Release /p:Version=2.9-stride -o drop/nuget
77+
# working-directory: docfx-build
78+
# shell: pwsh
79+
80+
# - name: Build Install DocFX
81+
# run: dotnet tool install -g docfx --version 2.9-stride --add-source drop/nuget
82+
# working-directory: docfx-build
83+
# shell: pwsh
84+
# End of Temporary solution
85+
86+
- name: Install DocFX
8587
# This installs the latest version of DocFX and may introduce breaking changes
8688
# run: dotnet tool update -g docfx
8789
# This installs a specific, tested version of DocFX.
88-
#run: dotnet tool update -g docfx --version 2.78.3
90+
run: dotnet tool update -g docfx --version 2.78.5
8991

9092
- name: Build documentation
9193
run: ./build-all.bat

‎.github/workflows/stride-docs-staging-azure.yml‎

Lines changed: 33 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -29,13 +29,13 @@ jobs:
2929

3030
steps:
3131
- name: .NET SDK Setup
32-
uses: actions/setup-dotnet@v4
32+
uses: actions/setup-dotnet@v5
3333
with:
3434
dotnet-version: 10.x
3535

3636
# Checkout the Stride Docs repository from the branch that triggered the workflow
3737
- name: Checkout Stride Docs
38-
uses: actions/checkout@v5
38+
uses: actions/checkout@v6
3939
with:
4040
path: ${{ env.DOCS_PATH }}
4141
lfs: true
@@ -57,7 +57,7 @@ jobs:
5757

5858
# Checkout the Stride repository from the default branch
5959
- name: Checkout Stride (note the LFS)
60-
uses: actions/checkout@v5
60+
uses: actions/checkout@v6
6161
with:
6262
repository: stride3d/stride
6363
token: ${{ secrets.GITHUB_TOKEN }}
@@ -66,37 +66,39 @@ jobs:
6666
ref: master
6767

6868
# Temporary solution till the new docfx is available
69-
- name: Checkout DocFX PR Branch
70-
uses: actions/checkout@v5
71-
with:
72-
repository: filzrev/docfx
73-
ref: feat-add-net10-support
74-
path: docfx-build
75-
76-
- name: Restore npm dependencies
77-
run: npm install
78-
working-directory: docfx-build/templates
79-
80-
- name: Build site templates
81-
run: npm run build
82-
working-directory: docfx-build/templates
69+
# - name: Checkout DocFX
70+
# uses: actions/checkout@v6
71+
# with:
72+
# repository: dotnet/docfx
73+
# # Tested commit
74+
# ref: 917cda864650279e0bbe50b852cb98601e5efa4d
75+
# path: docfx-build
76+
# fetch-depth: 0
77+
78+
# - name: Restore npm dependencies
79+
# run: npm install
80+
# working-directory: docfx-build/templates
81+
82+
# - name: Build site templates
83+
# run: npm run build
84+
# working-directory: docfx-build/templates
85+
86+
# - name: Build DocFX from PR
87+
# run: dotnet pack src/docfx -c Release /p:Version=2.9-stride -o drop/nuget
88+
# working-directory: docfx-build
89+
# shell: pwsh
8390

84-
- name: Build DocFX from PR
85-
run: dotnet pack src/docfx -c Release /p:Version=2.9-stride -o drop/nuget
86-
working-directory: docfx-build
87-
shell: pwsh
91+
# - name: Build Install DocFX
92+
# run: dotnet tool install -g docfx --version 2.9-stride --add-source drop/nuget
93+
# working-directory: docfx-build
94+
# shell: pwsh
95+
# End of Temporary solution
8896

89-
- name: Build Install DocFX
90-
run: dotnet tool install -g docfx --version 2.9-stride --add-source drop/nuget
91-
working-directory: docfx-build
92-
shell: pwsh
93-
# End of Temporary solution
94-
95-
#- name: Install DocFX
97+
- name: Install DocFX
9698
# This installs the latest version of DocFX and may introduce breaking changes
9799
# run: dotnet tool update -g docfx
98100
# This installs a specific, tested version of DocFX.
99-
#run: dotnet tool update -g docfx --version 2.78.3
101+
run: dotnet tool update -g docfx --version 2.78.5
100102

101103
- name: Build documentation
102104
run: ./build-all.bat
@@ -106,7 +108,7 @@ jobs:
106108
run: 7z a -r DocFX-app.zip ./${{ env.DOCS_PATH }}/_site/*
107109

108110
- name: Upload artifact for deployment job
109-
uses: actions/upload-artifact@v5
111+
uses: actions/upload-artifact@v6
110112
with:
111113
name: DocFX-app
112114
path: DocFX-app.zip
@@ -122,7 +124,7 @@ jobs:
122124

123125
steps:
124126
- name: Download artifact from build job
125-
uses: actions/download-artifact@v6
127+
uses: actions/download-artifact@v7
126128
with:
127129
name: DocFX-app
128130

0 commit comments

Comments
 (0)