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 19:06:02 -05:00
|
|
|
# SPDX-FileCopyrightText: 2019 yuzu Emulator Project
|
|
|
|
# SPDX-License-Identifier: GPL-2.0-or-later
|
|
|
|
|
2019-11-06 22:26:29 -06:00
|
|
|
param($BUILD_NAME)
|
|
|
|
|
2019-11-12 16:32:16 -06:00
|
|
|
$GITDATE = $(git show -s --date=short --format='%ad') -replace "-", ""
|
2019-10-02 16:53:53 -05:00
|
|
|
$GITREV = $(git show -s --format='%h')
|
2019-11-06 22:26:29 -06:00
|
|
|
|
|
|
|
if ("$BUILD_NAME" -eq "mainline") {
|
|
|
|
$RELEASE_DIST = "yuzu-windows-msvc"
|
2019-11-12 16:32:16 -06:00
|
|
|
}
|
|
|
|
else {
|
2019-11-06 22:26:29 -06:00
|
|
|
$RELEASE_DIST = "yuzu-windows-msvc-$BUILD_NAME"
|
|
|
|
}
|
2019-10-02 16:53:53 -05:00
|
|
|
|
|
|
|
$MSVC_BUILD_ZIP = "yuzu-windows-msvc-$GITDATE-$GITREV.zip" -replace " ", ""
|
|
|
|
$MSVC_BUILD_PDB = "yuzu-windows-msvc-$GITDATE-$GITREV-debugsymbols.zip" -replace " ", ""
|
|
|
|
$MSVC_SEVENZIP = "yuzu-windows-msvc-$GITDATE-$GITREV.7z" -replace " ", ""
|
2019-10-06 19:44:30 -05:00
|
|
|
$MSVC_TAR = "yuzu-windows-msvc-$GITDATE-$GITREV.tar" -replace " ", ""
|
|
|
|
$MSVC_TARXZ = "yuzu-windows-msvc-$GITDATE-$GITREV.tar.xz" -replace " ", ""
|
2019-11-12 16:32:16 -06:00
|
|
|
$MSVC_SOURCE = "yuzu-windows-msvc-source-$GITDATE-$GITREV" -replace " ", ""
|
|
|
|
$MSVC_SOURCE_TAR = "$MSVC_SOURCE.tar"
|
|
|
|
$MSVC_SOURCE_TARXZ = "$MSVC_SOURCE_TAR.xz"
|
2019-10-02 16:53:53 -05:00
|
|
|
|
|
|
|
$env:BUILD_ZIP = $MSVC_BUILD_ZIP
|
|
|
|
$env:BUILD_SYMBOLS = $MSVC_BUILD_PDB
|
|
|
|
$env:BUILD_UPDATE = $MSVC_SEVENZIP
|
|
|
|
|
|
|
|
$BUILD_DIR = ".\build\bin\Release"
|
|
|
|
|
2022-07-23 09:16:44 -05:00
|
|
|
# Cleanup unneeded data in submodules
|
|
|
|
git submodule foreach git clean -fxd
|
|
|
|
|
2019-11-12 16:32:16 -06:00
|
|
|
# Upload debugging symbols
|
2019-10-02 16:53:53 -05:00
|
|
|
mkdir pdb
|
|
|
|
Get-ChildItem "$BUILD_DIR\" -Recurse -Filter "*.pdb" | Copy-Item -destination .\pdb
|
|
|
|
7z a -tzip $MSVC_BUILD_PDB .\pdb\*.pdb
|
|
|
|
rm "$BUILD_DIR\*.pdb"
|
2019-11-12 16:32:16 -06:00
|
|
|
|
|
|
|
# Create artifact directories
|
2019-10-02 16:53:53 -05:00
|
|
|
mkdir $RELEASE_DIST
|
2019-11-12 16:32:16 -06:00
|
|
|
mkdir $MSVC_SOURCE
|
2019-10-02 16:53:53 -05:00
|
|
|
mkdir "artifacts"
|
|
|
|
|
2019-11-12 16:32:16 -06:00
|
|
|
# Build a tar.xz for the source of the release
|
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 19:06:02 -05:00
|
|
|
Copy-Item .\LICENSE.txt -Destination $MSVC_SOURCE
|
2019-11-12 16:32:16 -06:00
|
|
|
Copy-Item .\README.md -Destination $MSVC_SOURCE
|
2019-12-03 16:35:28 -06:00
|
|
|
Copy-Item .\CMakeLists.txt -Destination $MSVC_SOURCE
|
2019-11-12 16:32:16 -06:00
|
|
|
Copy-Item .\src -Recurse -Destination $MSVC_SOURCE
|
|
|
|
Copy-Item .\externals -Recurse -Destination $MSVC_SOURCE
|
|
|
|
Copy-Item .\dist -Recurse -Destination $MSVC_SOURCE
|
|
|
|
Copy-Item .\CMakeModules -Recurse -Destination $MSVC_SOURCE
|
|
|
|
7z a -r -ttar $MSVC_SOURCE_TAR $MSVC_SOURCE
|
|
|
|
7z a -r -txz $MSVC_SOURCE_TARXZ $MSVC_SOURCE_TAR
|
|
|
|
|
2022-07-15 21:29:44 -05:00
|
|
|
# Following section is quick hack to package artifacts differently for GitHub Actions
|
|
|
|
if ("$env:GITHUB_ACTIONS" -eq "true") {
|
|
|
|
echo "Hello GitHub Actions"
|
|
|
|
|
2022-07-25 17:56:10 -05:00
|
|
|
# With vcpkg we now have a few more dll files
|
|
|
|
ls .\build\bin\*.dll
|
|
|
|
cp .\build\bin\*.dll .\artifacts\
|
|
|
|
|
2022-07-15 21:29:44 -05:00
|
|
|
# Hopefully there is an exe in either .\build\bin or .\build\bin\Release
|
|
|
|
cp .\build\bin\yuzu*.exe .\artifacts\
|
|
|
|
Copy-Item "$BUILD_DIR\*" -Destination "artifacts" -Recurse
|
|
|
|
Remove-Item .\artifacts\tests.exe -ErrorAction ignore
|
|
|
|
|
|
|
|
# None of the other GHA builds are including source, so commenting out today
|
|
|
|
#Copy-Item $MSVC_SOURCE_TARXZ -Destination "artifacts"
|
|
|
|
|
|
|
|
# Are debug symbols important?
|
|
|
|
# cp .\build\bin\yuzu*.pdb .\pdb\
|
|
|
|
|
|
|
|
# Write out a tag BUILD_TAG to environment for the Upload step
|
|
|
|
# We're getting ${{ github.event.number }} as $env:PR_NUMBER"
|
|
|
|
echo "env:PR_NUMBER: $env:PR_NUMBER"
|
|
|
|
if (Test-Path env:PR_NUMBER) {
|
|
|
|
$PR_NUMBER = $env:PR_NUMBER.Substring(2) -as [int]
|
|
|
|
$PR_NUMBER_TAG = "pr"+([string]$PR_NUMBER).PadLeft(5,'0')
|
|
|
|
if ($PR_NUMBER -gt 1){
|
|
|
|
$BUILD_TAG="verify-$PR_NUMBER_TAG-$GITDATE-$GITREV"
|
|
|
|
} else {
|
|
|
|
$BUILD_TAG = "verify-$GITDATE-$GITREV"
|
|
|
|
}
|
|
|
|
} else {
|
|
|
|
# If env:PR_NUMBER isn't set, we should still write out a variable
|
|
|
|
$BUILD_TAG = "verify-$GITDATE-$GITREV"
|
|
|
|
}
|
|
|
|
echo "BUILD_TAG=$BUILD_TAG"
|
|
|
|
echo "BUILD_TAG=$BUILD_TAG" >> $env:GITHUB_ENV
|
|
|
|
|
|
|
|
# For extra job, just the exe
|
|
|
|
$INDIVIDUAL_EXE = "yuzu-msvc-$BUILD_TAG.exe"
|
|
|
|
echo "INDIVIDUAL_EXE=$INDIVIDUAL_EXE"
|
|
|
|
echo "INDIVIDUAL_EXE=$INDIVIDUAL_EXE" >> $env:GITHUB_ENV
|
|
|
|
echo "Just the exe: $INDIVIDUAL_EXE"
|
|
|
|
cp .\artifacts\yuzu.exe .\$INDIVIDUAL_EXE
|
|
|
|
|
|
|
|
|
|
|
|
} else {
|
|
|
|
|
2019-11-12 16:32:16 -06:00
|
|
|
# Build the final release artifacts
|
|
|
|
Copy-Item $MSVC_SOURCE_TARXZ -Destination $RELEASE_DIST
|
2019-10-02 16:53:53 -05:00
|
|
|
Copy-Item "$BUILD_DIR\*" -Destination $RELEASE_DIST -Recurse
|
|
|
|
rm "$RELEASE_DIST\*.exe"
|
|
|
|
Get-ChildItem "$BUILD_DIR" -Recurse -Filter "yuzu*.exe" | Copy-Item -destination $RELEASE_DIST
|
|
|
|
Get-ChildItem "$BUILD_DIR" -Recurse -Filter "QtWebEngineProcess*.exe" | Copy-Item -destination $RELEASE_DIST
|
|
|
|
7z a -tzip $MSVC_BUILD_ZIP $RELEASE_DIST\*
|
|
|
|
7z a $MSVC_SEVENZIP $RELEASE_DIST
|
|
|
|
|
2019-10-06 19:44:30 -05:00
|
|
|
7z a -r -ttar $MSVC_TAR $RELEASE_DIST
|
|
|
|
7z a -r -txz $MSVC_TARXZ $MSVC_TAR
|
|
|
|
|
2019-10-02 16:53:53 -05:00
|
|
|
Get-ChildItem . -Filter "*.zip" | Copy-Item -destination "artifacts"
|
2019-10-06 19:44:30 -05:00
|
|
|
Get-ChildItem . -Filter "*.7z" | Copy-Item -destination "artifacts"
|
2019-12-03 16:35:28 -06:00
|
|
|
Get-ChildItem . -Filter "*.tar.xz" | Copy-Item -destination "artifacts"
|
2022-07-15 21:29:44 -05:00
|
|
|
}
|