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

Update readme and make tagged releases include tag name in archive #5

Merged
merged 1 commit into from
May 14, 2024
Merged

Update readme and make tagged releases include tag name in archive #5

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
8 changes: 6 additions & 2 deletions .github/actions/archive/action.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,11 @@ runs:
[[ -z $sha_short ]] && sha_short="unknown"
echo "sha_short=$sha_short" >> "$GITHUB_OUTPUT"

export archive_name="conUDS_${sha_short}_${{ inputs.target }}.zip"
if [[ ${{ startsWith(github.ref, 'refs/tags/v') }} ]]; then
export archive_name="conUDS_${{ github.ref_name }}_${{ inputs.target }}.zip"
else
export archive_name="conUDS_${sha_short}_${{ inputs.target }}.zip"
fi
echo "archive_name=$archive_name" >> "$GITHUB_OUTPUT"

cat "$GITHUB_OUTPUT"
Expand All @@ -36,4 +40,4 @@ runs:
sha256sum $archive_name > CHECKSUM
rm "./conUDS/conUDS"

printf "\n✔ Successfully created the archive.\n"
printf "\n✔ Successfully created the archive: %s.\n" $archive_name
11 changes: 7 additions & 4 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,16 +13,19 @@ So far, this UDS client supports:
- App Downloading

# Building the Application
Releases are not currently set up yet, though eventually you will be able to simply download
a zip file containing the binary.

For now, you must set up Rust on your computer and use Cargo to build this application. Instructions for
## Download a release
Download a pre-built and packaged release from [the releases page](https://github.com/concordia-fsae/conUDS/releases).
Unzip it, and follow the rest of the instructions

## Build it yourself
You must have Rust and Cargo set up on your computer in order to build this application. Instructions for
setting up Rust are ubiquitous, so details are not provided here. See [here](https://www.rust-lang.org/tools/install)
for instructions.

Once Rust is installed, simply clone this repo, cd into the `conUDS` directory contained within it, and build the
application with Cargo:
`cargo build --release`
`cargo build --release` (you may omit the `--release` if you know what you're doing)

The resulting binary lives in the `target` directory which is created when building.

Expand Down
Loading