Skip to content

Commit c365413

Browse files
committed
update for the expected next version 4.20
1 parent 31ab6e9 commit c365413

1 file changed

Lines changed: 23 additions & 23 deletions

File tree

doc/workflows/instructions-generate-artifacts.md

Lines changed: 23 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -18,15 +18,15 @@ git push github main
1818
When actually executing, replace the remote name with `origin` and so on as appropriate.
1919

2020
## Notes for the version used in this document
21-
The instructions in this document generates artifacts for Highlight version **4.19**, and references **4.18** as the previous version.
21+
The instructions in this document generates artifacts for Highlight version **4.20**, and references **4.19** as the previous version.
2222

2323
Replace the version number with the desired version.
2424

2525
# Instruction steps for generating artifacts targeting specific versions of Highlight
2626

2727
## Create a working branch for generating artifacts
2828
```
29-
git switch -c artifact-highlight-4.19
29+
git switch -c artifact-highlight-4.20
3030
```
3131

3232
From then on, work on this branch.
@@ -35,9 +35,9 @@ From then on, work on this branch.
3535
Change the value of `Highlight_SourceVersionMajorMinor` property in the file [src/Highlight.Build.props](../../src/Highlight.Build.props).
3636

3737
```
38-
sed -i -e 's/Highlight_SourceVersionMajorMinor>4\.18/Highlight_SourceVersionMajorMinor>4\.19/g' src/Highlight.Build.props
38+
sed -i -e 's/Highlight_SourceVersionMajorMinor>4\.19/Highlight_SourceVersionMajorMinor>4\.20/g' src/Highlight.Build.props
3939
40-
git commit -m "bump build target version up to highlight-4.18" -- src/Highlight.Build.props
40+
git commit -m "bump build target version up to highlight-4.20" -- src/Highlight.Build.props
4141
```
4242

4343
Commit this change as it will be used in subsequent GitHub workflows.
@@ -54,20 +54,20 @@ Check for differences in generated source files of the bindings.
5454

5555
```
5656
cd src/Smdn.LibHighlightSharp.Bindings/Smdn.LibHighlightSharp.Bindings/
57-
diff highlight-4.18/ highlight-4.19/
57+
diff highlight-4.19/ highlight-4.20/
5858
cd -
5959
```
6060

6161
Then, commit the generated source files.
6262

6363
```
64-
git add src/Smdn.LibHighlightSharp.Bindings/Smdn.LibHighlightSharp.Bindings/highlight-4.19/
65-
git commit -m "add bindings for highlight-4.19" -- src/Smdn.LibHighlightSharp.Bindings/Smdn.LibHighlightSharp.Bindings/highlight-4.19/
64+
git add src/Smdn.LibHighlightSharp.Bindings/Smdn.LibHighlightSharp.Bindings/highlight-4.20/
65+
git commit -m "add bindings for highlight-4.20" -- src/Smdn.LibHighlightSharp.Bindings/Smdn.LibHighlightSharp.Bindings/highlight-4.20/
6666
```
6767

6868
### Push the working branch
6969
```
70-
git push github artifact-highlight-4.19
70+
git push github artifact-highlight-4.20
7171
```
7272

7373
### Generate native binaries
@@ -85,13 +85,13 @@ These PRs merge the created artifacts into a working branch. Changes to `SHA1SUM
8585
Fetch the changes up to this point.
8686

8787
```
88-
git pull github artifact-highlight-4.19
88+
git pull github artifact-highlight-4.20
8989
```
9090

9191
Create a PR to merge the changes up to this point into the `main` branch.
9292

9393
```
94-
gh pr create --base main --head artifact-highlight-4.19 --assignee @me --title "Add artifact highlight-4.19" --fill
94+
gh pr create --base main --head artifact-highlight-4.20 --assignee @me --title "Add artifact highlight-4.20" --fill
9595
```
9696

9797
Then, merge a PR created by this command, after testing and other checks have been completed.
@@ -101,15 +101,15 @@ Then, merge a PR created by this command, after testing and other checks have be
101101
git fetch github --prune
102102
git switch main
103103
git pull github main
104-
git branch -d artifact-highlight-4.19
104+
git branch -d artifact-highlight-4.20
105105
```
106106

107107
## Prepare for packaging and release
108108

109109
### Run tests with newly generated artifacts
110110
```
111-
dotnet test tests/Smdn.LibHighlightSharp.Bindings/
112-
dotnet test tests/Smdn.LibHighlightSharp/
111+
dotnet test --project tests/Smdn.LibHighlightSharp.Bindings/Smdn.LibHighlightSharp.Bindings.Tests.csproj
112+
dotnet test --project tests/Smdn.LibHighlightSharp/Smdn.LibHighlightSharp.Tests.csproj
113113
```
114114

115115
### Update `CompatibilitySuppressions.xml`
@@ -123,7 +123,7 @@ git diff src/Smdn.LibHighlightSharp.Bindings/CompatibilitySuppressions.xml
123123
Commit if there are any changes.
124124

125125
```
126-
git commit -m "add CompatibilitySuppressions entries for highlight >=4.19" -- src/Smdn.LibHighlightSharp.Bindings/CompatibilitySuppressions.xml
126+
git commit -m "add CompatibilitySuppressions entries for highlight >=4.20" -- src/Smdn.LibHighlightSharp.Bindings/CompatibilitySuppressions.xml
127127
```
128128

129129
### Push changes made up to this point
@@ -140,19 +140,19 @@ If necessary, also run a test workflow.
140140
Set the tag and trigger the release workflow. When trigger the workflow, ensure that the Actions secrets are properly updated and not expired.
141141

142142
```
143-
git tag -m "new release" new-release/main/Smdn.LibHighlightSharp.LangDefs-4.19.0
144-
git tag -m "new release" new-release/main/Smdn.LibHighlightSharp.Themes-4.19.0
145-
git tag -m "new release" new-release/main/Smdn.LibHighlightSharp.Bindings-4.19.0
143+
git tag -m "new release" new-release/main/Smdn.LibHighlightSharp.LangDefs-4.20.0
144+
git tag -m "new release" new-release/main/Smdn.LibHighlightSharp.Themes-4.20.0
145+
git tag -m "new release" new-release/main/Smdn.LibHighlightSharp.Bindings-4.20.0
146146
147147
git push github \
148-
new-release/main/Smdn.LibHighlightSharp.LangDefs-4.19.0 \
149-
new-release/main/Smdn.LibHighlightSharp.Themes-4.19.0 \
150-
new-release/main/Smdn.LibHighlightSharp.Bindings-4.19.0
148+
new-release/main/Smdn.LibHighlightSharp.LangDefs-4.20.0 \
149+
new-release/main/Smdn.LibHighlightSharp.Themes-4.20.0 \
150+
new-release/main/Smdn.LibHighlightSharp.Bindings-4.20.0
151151
152152
git tag -d \
153-
new-release/main/Smdn.LibHighlightSharp.LangDefs-4.19.0 \
154-
new-release/main/Smdn.LibHighlightSharp.Themes-4.19.0 \
155-
new-release/main/Smdn.LibHighlightSharp.Bindings-4.19.0
153+
new-release/main/Smdn.LibHighlightSharp.LangDefs-4.20.0 \
154+
new-release/main/Smdn.LibHighlightSharp.Themes-4.20.0 \
155+
new-release/main/Smdn.LibHighlightSharp.Bindings-4.20.0
156156
```
157157

158158
### Pull changes in the release

0 commit comments

Comments
 (0)