Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Updated BUILD.md with release instructions #13

Merged
merged 1 commit into from
Nov 29, 2024
Merged

Updated BUILD.md with release instructions #13

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 14 additions & 1 deletion BUILD.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,6 @@ Requirements doc can be found [here](https://docs.google.com/document/d/1DXrYdTb
* Tableau.Migration.App.GUI - Gui implementation using Avalonia framework.

# Building
```
## From Source Root
```
dotnet build Tableau.Migration.App.sln
Expand All @@ -37,3 +36,17 @@ dotnet run
```
dotnet test Tableau.Migration.App.sln
```
# Releasing
There are bash scripts found in the `/scripts` folder that details out the commands to publish the release files for the project.
Primarily there is the `release.sh` script to publish the release builds, and the `macos.sh` to create the macOS packages. Both of these scripts are used in the
github release hook.

## release.sh
`/scripts/release.sh` will perform a `dotnet publish` to create a release binary for multiple platforms (`win-x64`, `osx-arm64`, `osx-x64`, `linux-arm64`, `linux-x64`)
the releases are then placed into the `/build/` folder with each platform release under their own respective sub-directory.

## macos.sh
`/scripts/macos.sh` is a separate script that is meant to be run after the release builds are generated from `/scripts/release.sh`. This script takes the generated release binaries and packages them into a `.app` for macOS
The script itself takes in one of two arguments: `--x64` and `--arm64` to determine which macos package to generate. The output is then placed inside the `/build/` folder as `/build/osx_{platform}_macapp/TableauMigration.app`


2 changes: 1 addition & 1 deletion scripts/release.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,4 +11,4 @@ dotnet publish ./src/Tableau.Migration.App.GUI -c Release -r osx-x64 --self-cont

dotnet publish ./src/Tableau.Migration.App.GUI -c Release -r linux-arm64 --self-contained -p:PublishSingleFile=true /p:DebugType=None /p:GenerateDocumentationFile=false -o ${PROJECT_DIR}/build/linux_arm64

dotnet publish ./src/Tableau.Migration.App.GUI -c Release -r linux-arm64 --self-contained -p:PublishSingleFile=true /p:DebugType=None /p:GenerateDocumentationFile=false -o ${PROJECT_DIR}/build/linux_x64
dotnet publish ./src/Tableau.Migration.App.GUI -c Release -r linux-x64 --self-contained -p:PublishSingleFile=true /p:DebugType=None /p:GenerateDocumentationFile=false -o ${PROJECT_DIR}/build/linux_x64
Loading