Skip to content

Commit

Permalink
update for the version 4.9
Browse files Browse the repository at this point in the history
  • Loading branch information
smdn committed Nov 2, 2023
1 parent 24e5268 commit 122ccaa
Showing 1 changed file with 18 additions and 18 deletions.
36 changes: 18 additions & 18 deletions doc/workflows/instructions-generate-artifacts.md
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.8**, and references **4.7** as the previous version.
The instructions in this document generates artifacts for Highlight version **4.9**, and references **4.8** 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.8
git switch -c artifact-highlight-4.9
```

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\.7/Highlight_SourceVersionMajorMinor>4\.8/g' src/Highlight.Build.props
sed -i -e 's/Highlight_SourceVersionMajorMinor>4\.8/Highlight_SourceVersionMajorMinor>4\.9/g' src/Highlight.Build.props
git commit -m "bump build target version up to highlight-4.8" -- src/Highlight.Build.props
git commit -m "bump build target version up to highlight-4.9" -- src/Highlight.Build.props
```

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

```
cd src/Smdn.LibHighlightSharp.Bindings/Smdn.LibHighlightSharp.Bindings/
diff highlight-4.7/ highlight-4.8/
diff highlight-4.8/ highlight-4.9/
cd -
```

Then, commit the generated source files.

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

### Push the working branch
```
git push github artifact-highlight-4.8
git push github artifact-highlight-4.9
```

### Generate native binaries
Expand All @@ -86,13 +86,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.8
git pull github artifact-highlight-4.9
```

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

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

Then, merge a PR created by this command, after testing and other checks have been completed.
Expand All @@ -102,7 +102,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.8
git branch -d artifact-highlight-4.9
```

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

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

### Push changes made up to this point
Expand All @@ -141,15 +141,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.8.0
git tag -m "new release" new-release/main/Smdn.LibHighlightSharp.Themes-4.8.0
git tag -m "new release" new-release/main/Smdn.LibHighlightSharp.Bindings-4.8.0
git tag -m "new release" new-release/main/Smdn.LibHighlightSharp.LangDefs-4.9.0
git tag -m "new release" new-release/main/Smdn.LibHighlightSharp.Themes-4.9.0
git tag -m "new release" new-release/main/Smdn.LibHighlightSharp.Bindings-4.9.0
git push github main --tags
git tag -d new-release/main/Smdn.LibHighlightSharp.LangDefs-4.8.0
git tag -d new-release/main/Smdn.LibHighlightSharp.Themes-4.8.0
git tag -d new-release/main/Smdn.LibHighlightSharp.Bindings-4.8.0
git tag -d new-release/main/Smdn.LibHighlightSharp.LangDefs-4.9.0
git tag -d new-release/main/Smdn.LibHighlightSharp.Themes-4.9.0
git tag -d new-release/main/Smdn.LibHighlightSharp.Bindings-4.9.0
```

### Pull changes in the release
Expand Down

0 comments on commit 122ccaa

Please sign in to comment.