chore: make yuzu REUSE compliant
[REUSE] is a specification that aims at making file copyright
information consistent, so that it can be both human and machine
readable. It basically requires that all files have a header containing
copyright and licensing information. When this isn't possible, like
when dealing with binary assets, generated files or embedded third-party
dependencies, it is permitted to insert copyright information in the
`.reuse/dep5` file.
Oh, and it also requires that all the licenses used in the project are
present in the `LICENSES` folder, that's why the diff is so huge.
This can be done automatically with `reuse download --all`.
The `reuse` tool also contains a handy subcommand that analyzes the
project and tells whether or not the project is (still) compliant,
`reuse lint`.
Following REUSE has a few advantages over the current approach:
- Copyright information is easy to access for users / downstream
- Files like `dist/license.md` do not need to exist anymore, as
`.reuse/dep5` is used instead
- `reuse lint` makes it easy to ensure that copyright information of
files like binary assets / images is always accurate and up to date
To add copyright information of files that didn't have it I looked up
who committed what and when, for each file. As yuzu contributors do not
have to sign a CLA or similar I couldn't assume that copyright ownership
was of the "yuzu Emulator Project", so I used the name and/or email of
the commit author instead.
[REUSE]: https://reuse.software
Follow-up to 01cf05bc75b1e47beb08937439f3ed9339e7b254
2022-05-14 17:06:02 -07:00
|
|
|
# SPDX-FileCopyrightText: 2022 yuzu Emulator Project
|
|
|
|
# SPDX-License-Identifier: GPL-3.0-or-later
|
|
|
|
|
2021-12-22 22:31:57 -08:00
|
|
|
name: 'yuzu verify'
|
|
|
|
|
|
|
|
on:
|
|
|
|
pull_request:
|
2023-05-30 20:50:09 -07:00
|
|
|
branches: [ master ]
|
2022-07-15 19:29:44 -07:00
|
|
|
env:
|
|
|
|
PR_NUMBER: pr${{ github.event.number }}
|
2021-12-22 22:31:57 -08:00
|
|
|
|
|
|
|
jobs:
|
|
|
|
format:
|
2021-12-23 17:23:02 -08:00
|
|
|
name: 'verify format'
|
2021-12-22 22:31:57 -08:00
|
|
|
runs-on: ubuntu-latest
|
|
|
|
steps:
|
2022-07-05 17:41:49 -07:00
|
|
|
- uses: actions/checkout@v3
|
2021-12-22 22:31:57 -08:00
|
|
|
with:
|
|
|
|
submodules: false
|
2024-01-11 18:53:11 -08:00
|
|
|
- name: set up JDK 17
|
|
|
|
uses: actions/setup-java@v3
|
|
|
|
with:
|
|
|
|
java-version: '17'
|
|
|
|
distribution: 'temurin'
|
2021-12-22 22:31:57 -08:00
|
|
|
- name: 'Verify Formatting'
|
|
|
|
run: bash -ex ./.ci/scripts/format/script.sh
|
|
|
|
build:
|
|
|
|
name: 'test build'
|
|
|
|
needs: format
|
|
|
|
runs-on: ubuntu-latest
|
|
|
|
strategy:
|
|
|
|
fail-fast: false
|
|
|
|
matrix:
|
|
|
|
include:
|
|
|
|
- type: clang
|
|
|
|
image: linux-fresh
|
|
|
|
- type: linux
|
|
|
|
image: linux-fresh
|
|
|
|
- type: windows
|
|
|
|
image: linux-mingw
|
|
|
|
container:
|
|
|
|
image: yuzuemu/build-environments:${{ matrix.image }}
|
|
|
|
options: -u 1001
|
|
|
|
steps:
|
2022-07-05 17:41:49 -07:00
|
|
|
- uses: actions/checkout@v3
|
2021-12-22 22:31:57 -08:00
|
|
|
with:
|
|
|
|
submodules: recursive
|
|
|
|
fetch-depth: 0
|
|
|
|
- name: Set up cache
|
2022-07-05 17:41:49 -07:00
|
|
|
uses: actions/cache@v3
|
2021-12-23 17:23:02 -08:00
|
|
|
id: ccache-restore
|
2021-12-22 22:31:57 -08:00
|
|
|
with:
|
|
|
|
path: ~/.ccache
|
2021-12-23 17:23:02 -08:00
|
|
|
key: ${{ runner.os }}-${{ matrix.type }}-${{ github.sha }}
|
2021-12-22 22:31:57 -08:00
|
|
|
restore-keys: |
|
2021-12-23 17:23:02 -08:00
|
|
|
${{ runner.os }}-${{ matrix.type }}-
|
|
|
|
- name: Create ccache directory
|
|
|
|
if: steps.ccache-restore.outputs.cache-hit != 'true'
|
|
|
|
run: mkdir -p ~/.ccache
|
2021-12-22 22:31:57 -08:00
|
|
|
- name: Build
|
|
|
|
run: ./.ci/scripts/${{ matrix.type }}/docker.sh
|
|
|
|
env:
|
|
|
|
ENABLE_COMPATIBILITY_REPORTING: "ON"
|
2022-06-18 22:15:30 -07:00
|
|
|
- name: Pack
|
|
|
|
run: ./.ci/scripts/${{ matrix.type }}/upload.sh
|
|
|
|
env:
|
|
|
|
NO_SOURCE_PACK: "YES"
|
|
|
|
- name: Upload
|
|
|
|
uses: actions/upload-artifact@v3
|
|
|
|
with:
|
|
|
|
name: ${{ matrix.type }}
|
|
|
|
path: artifacts/
|
2023-11-27 12:48:54 -08:00
|
|
|
build-mac:
|
|
|
|
name: 'test build (macos)'
|
|
|
|
needs: format
|
|
|
|
runs-on: macos-13
|
|
|
|
steps:
|
|
|
|
- uses: actions/checkout@v3
|
|
|
|
with:
|
|
|
|
submodules: recursive
|
|
|
|
fetch-depth: 0
|
|
|
|
- name: Install dependencies
|
|
|
|
run: |
|
2023-12-13 10:30:41 -08:00
|
|
|
# workaround for https://github.com/actions/setup-python/issues/577
|
|
|
|
brew install autoconf automake boost@1.83 ccache ffmpeg fmt glslang hidapi libtool libusb lz4 ninja nlohmann-json openssl pkg-config qt@5 sdl2 speexdsp zlib zlib zstd || brew link --overwrite python@3.12
|
2023-11-27 12:48:54 -08:00
|
|
|
- name: Build
|
|
|
|
run: |
|
|
|
|
mkdir build
|
|
|
|
cd build
|
|
|
|
export Qt5_DIR="/usr/local/opt/qt@5/lib/cmake"
|
|
|
|
cmake .. -GNinja -DCMAKE_BUILD_TYPE=RelWithDebInfo -DYUZU_USE_BUNDLED_VCPKG=OFF -DYUZU_TESTS=OFF -DENABLE_WEB_SERVICE=OFF -DENABLE_LIBUSB=OFF
|
|
|
|
ninja
|
2021-12-23 17:23:02 -08:00
|
|
|
build-msvc:
|
|
|
|
name: 'test build (windows, msvc)'
|
|
|
|
needs: format
|
2022-08-30 11:28:33 -07:00
|
|
|
runs-on: windows-2022
|
2021-12-23 17:23:02 -08:00
|
|
|
steps:
|
2023-07-06 19:34:26 -07:00
|
|
|
- uses: actions/checkout@v3
|
|
|
|
with:
|
|
|
|
submodules: recursive
|
|
|
|
fetch-depth: 0
|
2021-12-23 17:23:02 -08:00
|
|
|
- name: Set up cache
|
2022-07-05 17:41:49 -07:00
|
|
|
uses: actions/cache@v3
|
2021-12-23 17:23:02 -08:00
|
|
|
with:
|
|
|
|
path: ~/.buildcache
|
|
|
|
key: ${{ runner.os }}-msvc-${{ github.sha }}
|
|
|
|
restore-keys: |
|
|
|
|
${{ runner.os }}-msvc-
|
|
|
|
- name: Install dependencies
|
2023-07-07 11:08:18 -07:00
|
|
|
shell: pwsh
|
2021-12-23 17:23:02 -08:00
|
|
|
run: |
|
2023-07-07 11:08:18 -07:00
|
|
|
$ErrorActionPreference = "Stop"
|
|
|
|
$BuildCacheVer = "v0.28.4"
|
|
|
|
$File = "buildcache-windows.zip"
|
|
|
|
$Uri = "https://github.com/mbitsnbites/buildcache/releases/download/$BuildCacheVer/$File"
|
|
|
|
$WebClient = New-Object System.Net.WebClient
|
|
|
|
$WebClient.DownloadFile($Uri, $File)
|
|
|
|
7z x $File
|
|
|
|
$CurrentDir = Convert-Path .
|
|
|
|
echo "$CurrentDir/buildcache/bin" | Out-File -FilePath $env:GITHUB_PATH -Encoding utf8 -Append
|
2023-07-06 17:30:54 -07:00
|
|
|
- name: Install Vulkan SDK
|
|
|
|
shell: pwsh
|
|
|
|
run: .\.ci\scripts\windows\install-vulkan-sdk.ps1
|
2021-12-23 17:23:02 -08:00
|
|
|
- name: Set up MSVC
|
|
|
|
uses: ilammy/msvc-dev-cmd@v1
|
|
|
|
- name: Configure
|
|
|
|
env:
|
|
|
|
CC: cl.exe
|
|
|
|
CXX: cl.exe
|
|
|
|
run: |
|
|
|
|
glslangValidator --version
|
|
|
|
mkdir build
|
2022-07-30 06:18:33 -07:00
|
|
|
cmake . -B build -GNinja -DCMAKE_TOOLCHAIN_FILE="CMakeModules/MSVCCache.cmake" -DUSE_CCACHE=ON -DYUZU_USE_BUNDLED_QT=1 -DYUZU_USE_BUNDLED_SDL2=1 -DYUZU_USE_QT_WEB_ENGINE=ON -DENABLE_COMPATIBILITY_LIST_DOWNLOAD=ON -DYUZU_ENABLE_COMPATIBILITY_REPORTING=ON -DUSE_DISCORD_PRESENCE=ON -DENABLE_QT_TRANSLATION=ON -DCMAKE_BUILD_TYPE=Release -DGIT_BRANCH=pr-verify -DYUZU_CRASH_DUMPS=ON
|
2021-12-23 17:23:02 -08:00
|
|
|
- name: Build
|
|
|
|
run: cmake --build build
|
|
|
|
- name: Cache Summary
|
|
|
|
run: buildcache -s
|
2022-06-18 22:15:30 -07:00
|
|
|
- name: Pack
|
|
|
|
shell: pwsh
|
|
|
|
run: .\.ci\scripts\windows\upload.ps1
|
|
|
|
- name: Upload
|
|
|
|
uses: actions/upload-artifact@v3
|
|
|
|
with:
|
|
|
|
name: msvc
|
|
|
|
path: artifacts/
|
2022-07-15 19:29:44 -07:00
|
|
|
- name: Upload EXE
|
|
|
|
uses: actions/upload-artifact@v3
|
|
|
|
with:
|
|
|
|
name: ${{ env.INDIVIDUAL_EXE }}
|
|
|
|
path: ${{ env.INDIVIDUAL_EXE }}
|
2023-03-03 21:38:56 -08:00
|
|
|
android:
|
|
|
|
runs-on: ubuntu-latest
|
|
|
|
needs: format
|
|
|
|
steps:
|
|
|
|
- uses: actions/checkout@v3
|
|
|
|
with:
|
|
|
|
submodules: recursive
|
2023-03-05 16:58:50 -08:00
|
|
|
fetch-depth: 0
|
2023-06-06 04:06:34 -07:00
|
|
|
- name: set up JDK 17
|
|
|
|
uses: actions/setup-java@v3
|
|
|
|
with:
|
|
|
|
java-version: '17'
|
2023-03-05 16:58:50 -08:00
|
|
|
distribution: 'temurin'
|
2023-03-03 21:38:56 -08:00
|
|
|
- name: Set up cache
|
|
|
|
uses: actions/cache@v3
|
|
|
|
with:
|
|
|
|
path: |
|
|
|
|
~/.gradle/caches
|
|
|
|
~/.gradle/wrapper
|
|
|
|
~/.ccache
|
|
|
|
key: ${{ runner.os }}-android-${{ github.sha }}
|
|
|
|
restore-keys: |
|
|
|
|
${{ runner.os }}-android-
|
|
|
|
- name: Query tag name
|
2023-05-27 21:36:56 -07:00
|
|
|
uses: olegtarasov/get-tag@v2.1.2
|
2023-03-03 21:38:56 -08:00
|
|
|
id: tagName
|
|
|
|
- name: Install dependencies
|
|
|
|
run: |
|
|
|
|
sudo apt-get update
|
|
|
|
sudo apt-get install -y ccache apksigner glslang-dev glslang-tools
|
|
|
|
- name: Build
|
|
|
|
run: ./.ci/scripts/android/build.sh
|
|
|
|
- name: Copy and sign artifacts
|
|
|
|
env:
|
|
|
|
ANDROID_KEYSTORE_B64: ${{ secrets.ANDROID_KEYSTORE_B64 }}
|
|
|
|
ANDROID_KEY_ALIAS: ${{ secrets.ANDROID_KEY_ALIAS }}
|
|
|
|
ANDROID_KEYSTORE_PASS: ${{ secrets.ANDROID_KEYSTORE_PASS }}
|
|
|
|
run: ./.ci/scripts/android/upload.sh
|
|
|
|
- name: Upload
|
|
|
|
uses: actions/upload-artifact@v3
|
|
|
|
with:
|
|
|
|
name: android
|
|
|
|
path: artifacts/
|