v2.4.2リリース準備

.editorconfig

@@ -7,3 +7,15 @@ indent_size = 4
 
 # 行末のスペースは自動的に削る
 trim_trailing_whitespace = true
+
+[*.md]
+# インデントスタイル：空白文字で2スペース幅
+indent_style = space
+indent_size = 2
+
+# mdファイルの行末スペースには意味があるので削らない
+trim_trailing_whitespace = false
+
+[*.{vcxproj,vcxproj.filters}]
+# ファイル末尾に改行を追加しない
+insert_final_newline = false

.gitattributes

@@ -1,5 +1,20 @@
 *.kwd text
 *.khp text
 *.hkn text
-*.bat text
-Makefile text eolf=lf
+*.bat text eol=crlf
+Makefile text eol=lf
+sakura_rc.h text eol=crlf
+*.rc text working-tree-encoding=utf-16le-bom eol=crlf
+*.rc2 text working-tree-encoding=utf-16le-bom eol=crlf
+*.ps1 text working-tree-encoding=utf-16le-bom eol=crlf
+*.config text eol=crlf
+*.csproj text eol=crlf
+*.filters text eol=crlf
+*.manifest text eol=crlf
+*.natvis text eol=crlf
+*.props text eol=crlf
+*.settings text eol=crlf
+*.sln text eol=crlf
+*.targets text eol=crlf
+*.vcxproj text eol=crlf
+*.vsconfig text eol=crlf

.github/PULL_REQUEST_TEMPLATE.md

@@ -52,6 +52,10 @@
 <!-- 機能追加の場合は、その仕様や動作を記載してください。 -->
 <!-- その他の場合は、必要に応じて処理の仕様や動作説明を記載してください。 -->
 
+## <!-- わかる範囲で --> PR の影響範囲
+
+<!-- 既存の処理に対して影響範囲を記載してください。 -->
+
 ## <!-- 必須 --> テスト内容
 
 <!-- PR を投げるにあたってテストした内容を記載してください -->
@@ -63,10 +67,6 @@
 手順
 
 
-## <!-- わかる範囲で --> PR の影響範囲
-
-<!-- 既存の処理に対して影響範囲を記載してください。 -->
-
 ## <!-- なければ省略可 --> 関連 issue, PR
 
 <!-- 関連する issue, PR の情報を記載してください。 -->

.github/workflows/build-sakura.yml

@@ -3,23 +3,16 @@ name: build sakura
 # Controls when the action will run. Triggers the workflow on push or pull request
 # events but only for the master branch
 on:
+  workflow_dispatch:
   push:
-    branches:
-      - master
-      - feature/*
     paths-ignore:
       - '**/*.md'
       - .gitignore
       - .editorconfig
       - appveyor.yml
       - 'azure-pipelines*.yml'
       - 'ci/azure-pipelines/template*.yml'
-
   pull_request:
-    branches:
-      - master
-      - feature/*
-      - release/*
     paths-ignore:
       - '**/*.md'
       - .gitignore
@@ -34,10 +27,13 @@ jobs:
   build:
     # The type of runner that the job will run on
     name: MSBuild
-    runs-on: windows-latest
+    runs-on: ${{matrix.os}}
 
     strategy:
       matrix:
+        os:
+          - windows-2019
+          - windows-2022
         config:
           - Debug
           - Release
@@ -49,31 +45,129 @@ jobs:
     steps:
     ## see https://github.com/actions/checkout
     - uses: actions/checkout@v2
+      with:
+        fetch-depth: 0
 
     ## see https://github.com/microsoft/setup-msbuild
     - name: Add msbuild to PATH
-      uses: microsoft/[email protected]
+      uses: microsoft/setup-msbuild@v1
+
+    - name: Setup environment variables
+      run: |
+        echo "CI_ACCOUNT_NAME=${{github.actor}}" >> $env:GITHUB_ENV
+        echo "CI_REPO_NAME=${{github.repository}}" >> $env:GITHUB_ENV
+        echo "CI_BUILD_VERSION=${{github.run_id}}" >> $env:GITHUB_ENV
+        echo "CI_BUILD_NUMBER=${{github.run_number}}" >> $env:GITHUB_ENV
+
+        echo("CI_BUILD_URL=" `
+          + "${env:GITHUB_SERVER_URL}/${{github.repository}}/" `
+          + "actions/runs/${{github.run_id}}") >> $env:GITHUB_ENV
+
+        echo("GITHUB_COMMIT_URL=" `
+          + "${env:GITHUB_SERVER_URL}/${{github.repository}}/" `
+          + "commit/${{github.sha}}") >> $env:GITHUB_ENV
+
+        if ('pull_request' -eq '${{github.event_name}}') {
+          echo("GITHUB_PR_NUMBER=" `
+            + "${{github.event.pull_request.number}}") >> $env:GITHUB_ENV
+          echo("GITHUB_PR_HEAD_SHORT_COMMIT=" `
+            + "${{github.event.pull_request.head.sha}}".SubString(0, 8)) >> $env:GITHUB_ENV
+          echo("GITHUB_PR_HEAD_COMMIT=" `
+            + "${{github.event.pull_request.head.sha}}") >> $env:GITHUB_ENV
+          echo("GITHUB_PR_HEAD_URL=" `
+            + "${env:GITHUB_SERVER_URL}/${{github.repository}}/" `
+            + "pull/${{github.event.pull_request.number}}/" `
+            + "commits/${{github.event.pull_request.head.sha}}") >> $env:GITHUB_ENV
+        }
+      shell: pwsh
 
     - name: MSBuild
       run: build-sln.bat ${{ matrix.platform }} ${{ matrix.config }}
       shell: cmd
 
-    ## #922 のため無効化
-    #
-    #- name: Build HTML Help
-    #  run: build-chm.bat
-    #  shell: cmd
-    #
-    #- name: Build installer with Inno Setup
-    #  run: build-installer.bat ${{ matrix.platform }} ${{ matrix.config }}
-    #  shell: cmd
+    - name: Run unit tests
+      run: .\tests1.exe --gtest_output=xml:${{github.workspace}}\tests1.exe-googletest-${{matrix.platform}}-${{matrix.config}}.xml
+      working-directory: ${{github.workspace}}\${{matrix.platform}}\${{matrix.config}}
+      shell: pwsh
+
+    - name: Install Locale Emulator
+      run: |
+        choco install autohotkey.install --confirm
+        $LEExpandDir = "${{github.workspace}}\tools\locale-emulator"
+        $LEInitScript = "${{github.workspace}}\ci\init-locale-emulator.ahk"
+        New-Item "${LEExpandDir}" -ItemType Directory
+        Invoke-WebRequest `
+          "https://github.com/xupefei/Locale-Emulator/releases/download/v2.5.0.1/Locale.Emulator.2.5.0.1.zip" `
+          -OutFile "${LEExpandDir}\locale-emulator.zip"
+        Expand-Archive "${LEExpandDir}\locale-emulator.zip" "${LEExpandDir}"
+        Start-Process "AutoHotKey" "${LEInitScript}"
+        Start-Process "${LEExpandDir}\LEInstaller.exe"
+        echo "${LEExpandDir}" >> $env:GITHUB_PATH
+      shell: pwsh
+
+    - name: Build HTML Help
+      run: build-chm.bat
+      shell: cmd
+
+    - name: Update/Install Inno Setup
+      run: choco upgrade innosetup --confirm
+      shell: pwsh
+
+    - name: Build installer with Inno Setup
+      run: build-installer.bat ${{ matrix.platform }} ${{ matrix.config }}
+      shell: cmd
+
     - name: zipArtifacts
       run: zipArtifacts.bat ${{ matrix.platform }} ${{ matrix.config }}
+      if: ${{ matrix.config == 'Release' }}
       shell: cmd
 
     ## see https://github.com/actions/upload-artifact
-    - name: Upload
+    - name: Upload Installer
+      uses: actions/upload-artifact@v2
+      if: ${{ matrix.config == 'Release' }}
+      with:
+        name: Installer ${{ matrix.platform }} ${{ matrix.config }}
+        path: 'sakura-*-Installer.zip'
+
+    - name: Upload Installer MD5
+      uses: actions/upload-artifact@v2
+      if: ${{ matrix.config == 'Release' }}
+      with:
+        name: Installer MD5 ${{ matrix.platform }} ${{ matrix.config }}
+        path: 'sakura-*-Installer.zip.md5'
+
+    - name: Upload Exe
+      uses: actions/upload-artifact@v2
+      if: ${{ matrix.config == 'Release' }}
+      with:
+        name: Exe ${{ matrix.platform }} ${{ matrix.config }}
+        path: 'sakura-*-Exe.zip'
+
+    - name: Upload Exe MD5
+      uses: actions/upload-artifact@v2
+      if: ${{ matrix.config == 'Release' }}
+      with:
+        name: Exe MD5 ${{ matrix.platform }} ${{ matrix.config }}
+        path: 'sakura-*-Exe.zip.md5'
+
+    - name: Upload Log
+      uses: actions/upload-artifact@v2
+      if: ${{ matrix.config == 'Release' }}
+      with:
+        name: Log ${{ matrix.platform }} ${{ matrix.config }}
+        path: 'sakura-*-Log.zip'
+
+    - name: Upload Asm
+      uses: actions/upload-artifact@v2
+      if: ${{ matrix.config == 'Release' }}
+      with:
+        name: Asm ${{ matrix.platform }} ${{ matrix.config }}
+        path: 'sakura-*-Asm.zip'
+
+    - name: Upload Dev
       uses: actions/upload-artifact@v2
+      if: ${{ matrix.config == 'Release' }}
       with:
-        name: exe ${{ matrix.platform }} ${{ matrix.config }}
-        path: '*.zip'
+        name: Dev ${{ matrix.platform }} ${{ matrix.config }}
+        path: 'sakura-*-Dev.zip'

.github/workflows/sonarscan.yml

@@ -0,0 +1,153 @@
+name: SonarCloud
+
+# Controls when the action will run. Triggers the workflow on push or pull request
+# events but only for the master branch
+on:
+  workflow_dispatch:
+  push:
+    paths-ignore:
+      - '**/*.md'
+      - 'ci/**/*'
+      - .gitignore
+      - .editorconfig
+      - appveyor.yml
+      - azure-pipelines.yml
+  pull_request_target:
+    types: [opened, synchronize]
+    paths-ignore:
+      - '**/*.md'
+      - 'ci/**/*'
+      - .gitignore
+      - .editorconfig
+      - appveyor.yml
+      - azure-pipelines.yml
+  schedule:
+    - cron:  '45 7 * * FRI'
+
+# A workflow run is made up of one or more jobs that can run sequentially or in parallel
+jobs:
+  sonar:
+    name: Scan
+    runs-on: windows-latest
+
+    env:
+      BUILD_PLATFORM: x64
+      BUILD_CONFIGURATION: Debug
+      SONAR_QUBE_VERSION: '4.7.0.2747'
+
+    steps:
+    - name: Checkout
+      uses: actions/checkout@v2
+      with:
+        ref: '${{ github.event.pull_request.head.sha }}'
+        fetch-depth: 0
+
+    - name: Setup environment variables
+      run: |
+        echo "SONAR_USER_HOME=${{ github.workspace }}" >> $env:GITHUB_ENV
+        if ('${{ env.GITHUB_BASE_REF }}' -ne '')
+        {
+          echo "BASE_SHA=$(git show -s --format=%H ${{ env.GITHUB_BASE_REF }})" >> $env:GITHUB_ENV
+        }
+        New-Item -Path .sonar -ItemType Directory
+
+    - name: Cache Sonar Analysis
+      uses: actions/cache@v2
+      with:
+        path: |
+          .sonar\cache
+          .sonar\analysis-cache
+        key:
+          sonar-cache-${{ env.SONAR_QUBE_VERSION }}-${{ github.sha }}
+        restore-keys:
+          sonar-cache-${{ env.SONAR_QUBE_VERSION }}-${{ env.BASE_SHA }}
+
+    - name: Setup MSBuild
+      uses: microsoft/setup-msbuild@v1
+
+    - name: Fetch Build-Wrapper
+      working-directory: ${{ github.workspace }}\.sonar
+      run: |
+        Invoke-WebRequest -OutFile build-wrapper-win-x86.zip https://sonarcloud.io/static/cpp/build-wrapper-win-x86.zip
+        7z rn build-wrapper-win-x86.zip build-wrapper-win-x86 build-wrapper
+        7z x build-wrapper-win-x86.zip
+
+    - name: Build with Build-Wrapper
+      env:
+        SONAR_TOKEN: ${{ secrets.SONAR_TOKEN }}
+      if: env.SONAR_TOKEN
+      run: .sonar\build-wrapper\build-wrapper-win-x86-64.exe
+        --out-dir bw-output
+        MsBuild.exe
+        /p:Platform=${{ env.BUILD_PLATFORM }}
+        /p:Configuration=${{ env.BUILD_CONFIGURATION }}
+        /t:ReBuild
+
+    - name: Install OpenCppCoverage with XmlExporter
+      env:
+        SONAR_TOKEN: ${{ secrets.SONAR_TOKEN }}
+      if: env.SONAR_TOKEN
+      working-directory: ${{ runner.temp }}
+      run: |
+        choco install OpenCppCoverage -y
+        Invoke-WebRequest -OutFile XmlExporter-x64.zip https://github.com/berryzplus/XmlExporter/releases/download/v1.0.0/XmlExporter-x64.zip
+        7z e XmlExporter-x64.zip
+        Move-Item -Path XmlExporter.dll -Destination "C:\Program Files\OpenCppCoverage\Plugins\Exporter\xml.dll"
+        echo "C:\Program Files\OpenCppCoverage" >> $env:GITHUB_PATH
+
+    - name: Run Tests
+      env:
+        SONAR_TOKEN: ${{ secrets.SONAR_TOKEN }}
+      if: env.SONAR_TOKEN
+      run: |
+        $env:CMD_TESTS1 = $(Get-ChildItem -Recurse tests1.exe)[0].FullName
+        OpenCppCoverage.exe `
+        --export_type xml:tests1-coverage.xml `
+        --modules $env:CMD_TESTS1  `
+        --sources ${{ github.workspace }} `
+        --excluded_sources ${{ github.workspace }}\tests\googletest `
+        --working_dir .\${{ env.BUILD_PLATFORM }}\${{ env.BUILD_CONFIGURATION }} `
+        --cover_children `
+        -- `
+        $env:CMD_TESTS1 `
+        --gtest_output=xml:${{ github.workspace }}\tests1-googletest.xml
+
+    - name: Set up JDK 11
+      uses: actions/setup-java@v1
+      with:
+        java-version: 11
+
+    - name: Fetch SonarScanner
+      working-directory: ${{ github.workspace }}\.sonar
+      run: |
+        Invoke-WebRequest -OutFile sonar-scanner.zip https://binaries.sonarsource.com/Distribution/sonar-scanner-cli/sonar-scanner-cli-${{ env.SONAR_QUBE_VERSION }}.zip
+        7z rn sonar-scanner.zip sonar-scanner-${{ env.SONAR_QUBE_VERSION }} scanner
+        7z x sonar-scanner.zip
+
+    - name: Analyze with SonarScanner
+      env:
+        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        SONAR_TOKEN: ${{ secrets.SONAR_TOKEN }}
+      if: env.SONAR_TOKEN
+      run: |
+        if ('${{ github.event_name }}' -eq 'pull_request_target')
+        {
+          $env:GITHUB_EVENT_NAME = 'pull_request'
+          $env:GITHUB_SHA = $(git show -s --format=%H)
+          $env:GITHUB_REF = 'refs/pull/${{ github.event.number }}/merge'
+        }
+        .\.sonar\scanner\bin\sonar-scanner.bat `
+        -D"sonar.organization=${{ github.repository_owner }}" `
+        -D"sonar.projectKey=$('${{ github.repository }}' -replace '/', '_')" `
+        -D"sonar.host.url=https://sonarcloud.io" `
+        -D"sonar.sourceEncoding=UTF-8" `
+        -D"sonar.sources=." `
+        -D"sonar.cfamily.build-wrapper-output=bw-output" `
+        -D"sonar.cfamily.cache.enabled=true" `
+        -D"sonar.cfamily.cache.path=.sonar\analysis-cache" `
+        -D"sonar.cfamily.cppunit.reportPath=tests1-googletest.xml" `
+        -D"sonar.cfamily.threads=2" `
+        -D"sonar.python.version=3" `
+        -D"sonar.coverage.exclusions=help\**\*.js,tests\unittests\coverage.cpp,tests\stubs\**\*.cpp,tools\**\*.js" `
+        -D"sonar.coverageReportPaths=tests1-coverage.xml" `
+        -D"sonar.exclusions=.sonar\**\*,build\**\*,bw-output\**\*,HeaderMake\**\*,tests\googletest\**\,**\test-*,tests\stubs\**\*,tests*-*.xml*"