Skip to content

Commit

Permalink
update for the expected next version 4.12
Browse files Browse the repository at this point in the history
  • Loading branch information
@smdn
smdn committed Mar 20, 2024
1 parent 4bfcab7 commit 2f0d644
Showing 1 changed file with 17 additions and 19 deletions.
36 changes: 17 additions & 19 deletions doc/workflows/instructions-generate-artifacts.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -18,15 +18,15 @@ git push github main
When actually executing, replace the remote name with `origin` and so on as appropriate.

## Notes for the version used in this document
The instructions in this document generates artifacts for Highlight version **4.11**, and references **4.10** as the previous version.
The instructions in this document generates artifacts for Highlight version **4.12**, and references **4.11** as the previous version.

Replace the version number with the desired version.

# Instruction steps for generating artifacts targeting specific versions of Highlight

## Create a working branch for generating artifacts
```
git switch -c artifact-highlight-4.11
git switch -c artifact-highlight-4.12
```

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

```
sed -i -e 's/Highlight_SourceVersionMajorMinor>4\.10/Highlight_SourceVersionMajorMinor>4\.11/g' src/Highlight.Build.props
sed -i -e 's/Highlight_SourceVersionMajorMinor>4\.11/Highlight_SourceVersionMajorMinor>4\.12/g' src/Highlight.Build.props
git commit -m "bump build target version up to highlight-4.11" -- src/Highlight.Build.props
git commit -m "bump build target version up to highlight-4.12" -- src/Highlight.Build.props
```

Commit this change as it will be used in subsequent GitHub workflows.
Expand All @@ -54,21 +54,19 @@ Check for differences in generated source files of the bindings.

```
cd src/Smdn.LibHighlightSharp.Bindings/Smdn.LibHighlightSharp.Bindings/
diff highlight-4.10/ highlight-4.11/
diff highlight-4.11/ highlight-4.12/
cd -
```

Then, commit the generated source files.

```
git add src/Smdn.LibHighlightSharp.Bindings/Smdn.LibHighlightSharp.Bindings/highlight-4.11/
git commit -m "add bindings for highlight-4.11" -- src/Smdn.LibHighlightSharp.Bindings/Smdn.LibHighlightSharp.Bindings/highlight-4.11/
git commit -m "add bindings for highlight-4.12" -- src/Smdn.LibHighlightSharp.Bindings/Smdn.LibHighlightSharp.Bindings/highlight-4.12/
```

### Push the working branch
```
git push github artifact-highlight-4.11
git push github artifact-highlight-4.12
```

### Generate native binaries
Expand All @@ -86,13 +84,13 @@ These PRs merge the created artifacts into a working branch. Changes to `SHA1SUM
Fetch the changes up to this point.

```
git pull github artifact-highlight-4.11
git pull github artifact-highlight-4.12
```

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

```
gh pr create --base main --head artifact-highlight-4.11 --assignee @me --title "Add artifact highlight-4.11" --fill
gh pr create --base main --head artifact-highlight-4.12 --assignee @me --title "Add artifact highlight-4.12" --fill
```

Then, merge a PR created by this command, after testing and other checks have been completed.
Expand All @@ -102,7 +100,7 @@ Then, merge a PR created by this command, after testing and other checks have be
git fetch github --prune
git switch main
git pull github main
git branch -d artifact-highlight-4.11
git branch -d artifact-highlight-4.12
```

## Prepare for packaging and release
Expand All @@ -124,7 +122,7 @@ git diff src/Smdn.LibHighlightSharp.Bindings/CompatibilitySuppressions.xml
Commit if there are any changes.

```
git commit -m "add CompatibilitySuppressions entries for highlight >=4.11" -- src/Smdn.LibHighlightSharp.Bindings/CompatibilitySuppressions.xml
git commit -m "add CompatibilitySuppressions entries for highlight >=4.12" -- src/Smdn.LibHighlightSharp.Bindings/CompatibilitySuppressions.xml
```

### Push changes made up to this point
Expand All @@ -141,15 +139,15 @@ If necessary, also run a test workflow.
Set the tag and trigger the release workflow. When trigger the workflow, ensure that the Actions secrets are properly updated and not expired.

```
git tag -m "new release" new-release/main/Smdn.LibHighlightSharp.LangDefs-4.11.0
git tag -m "new release" new-release/main/Smdn.LibHighlightSharp.Themes-4.11.0
git tag -m "new release" new-release/main/Smdn.LibHighlightSharp.Bindings-4.11.0
git tag -m "new release" new-release/main/Smdn.LibHighlightSharp.LangDefs-4.12.0
git tag -m "new release" new-release/main/Smdn.LibHighlightSharp.Themes-4.12.0
git tag -m "new release" new-release/main/Smdn.LibHighlightSharp.Bindings-4.12.0
git push github main --tags
git tag -d new-release/main/Smdn.LibHighlightSharp.LangDefs-4.11.0
git tag -d new-release/main/Smdn.LibHighlightSharp.Themes-4.11.0
git tag -d new-release/main/Smdn.LibHighlightSharp.Bindings-4.11.0
git tag -d new-release/main/Smdn.LibHighlightSharp.LangDefs-4.12.0
git tag -d new-release/main/Smdn.LibHighlightSharp.Themes-4.12.0
git tag -d new-release/main/Smdn.LibHighlightSharp.Bindings-4.12.0
```

### Pull changes in the release
Expand Down

0 comments on commit 2f0d644

Please sign in to comment.