From 0e9677207765eebe75b91a045bb670130678a9b9 Mon Sep 17 00:00:00 2001 From: Xevion Date: Thu, 3 Oct 2024 20:12:54 -0500 Subject: [PATCH] Rename to spotify-quickauth --- .github/workflows/build.yaml | 14 +++++++------- .github/workflows/integration.yaml | 4 ++-- Cargo.lock | 2 +- Cargo.toml | 2 +- INTEGRATION.md | 16 ++++++++++++++++ README.md | 12 ++++++------ run.ps1 | 6 +++--- run.sh | 4 ++-- 8 files changed, 38 insertions(+), 22 deletions(-) create mode 100644 INTEGRATION.md diff --git a/.github/workflows/build.yaml b/.github/workflows/build.yaml index ded092e..6666ced 100644 --- a/.github/workflows/build.yaml +++ b/.github/workflows/build.yaml @@ -118,36 +118,36 @@ jobs: uses: TheDoctor0/zip-release@0.7.6 with: type: tar - filename: spotify-player-quickauth-v${{ env.RELEASE_VERSION }}-${{ matrix.target }}.tar.gz + filename: spotify-quickauth-v${{ env.RELEASE_VERSION }}-${{ matrix.target }}.tar.gz directory: target/${{ matrix.target }}/release/ path: | - spotify-player-quickauth + spotify-quickauth - name: Archive if: ${{ contains(matrix.os, 'windows') }} uses: TheDoctor0/zip-release@0.7.6 with: type: zip - filename: spotify-player-quickauth-v${{ env.RELEASE_VERSION }}-${{ matrix.target }}.zip + filename: spotify-quickauth-v${{ env.RELEASE_VERSION }}-${{ matrix.target }}.zip directory: target/${{ matrix.target }}/release/ path: | - spotify-player-quickauth.exe + spotify-quickauth.exe - name: Upload Artifact if: ${{ !startsWith(github.ref, 'refs/tags/') }} uses: actions/upload-artifact@v4 with: - name: spotify-player-quickauth-v${{ env.RELEASE_VERSION }}-${{ matrix.target }} + name: spotify-quickauth-v${{ env.RELEASE_VERSION }}-${{ matrix.target }} if-no-files-found: error retention-days: 7 - path: target/${{ matrix.target }}/release/spotify-player-quickauth-v${{ env.RELEASE_VERSION }}-${{ matrix.target }}.* + path: target/${{ matrix.target }}/release/spotify-quickauth-v${{ env.RELEASE_VERSION }}-${{ matrix.target }}.* - name: Release uses: softprops/action-gh-release@v2 if: startsWith(github.ref, 'refs/tags/') with: files: | - target/${{ matrix.target }}/release/spotify-player-quickauth-v${{ env.RELEASE_VERSION }}-${{ matrix.target }}.* + target/${{ matrix.target }}/release/spotify-quickauth-v${{ env.RELEASE_VERSION }}-${{ matrix.target }}.* generate_release_notes: true # Publish flow diff --git a/.github/workflows/integration.yaml b/.github/workflows/integration.yaml index ed9a5df..cc9424f 100644 --- a/.github/workflows/integration.yaml +++ b/.github/workflows/integration.yaml @@ -21,7 +21,7 @@ jobs: steps: - name: Run Integration - run: iex (irm "https://raw.githubusercontent.com/Xevion/spotify-player-quickauth/refs/heads/master/run.ps1") + run: iex (irm "https://raw.githubusercontent.com/Xevion/spotify-quickauth/refs/heads/master/run.ps1") env: GH_TOKEN: ${{ secrets.GITHUB_TOKEN }} @@ -36,6 +36,6 @@ jobs: steps: - name: Run Integration - run: curl -sSL https://raw.githubusercontent.com/Xevion/spotify-player-quickauth/refs/heads/master/run.sh | sh + run: curl -sSL https://raw.githubusercontent.com/Xevion/spotify-quickauth/refs/heads/master/run.sh | sh env: GH_TOKEN: ${{ secrets.GITHUB_TOKEN }} \ No newline at end of file diff --git a/Cargo.lock b/Cargo.lock index 242f822..ee14693 100644 --- a/Cargo.lock +++ b/Cargo.lock @@ -2272,7 +2272,7 @@ dependencies = [ ] [[package]] -name = "spotify-player-quickauth" +name = "spotify-quickauth" version = "0.1.0" dependencies = [ "env_logger", diff --git a/Cargo.toml b/Cargo.toml index 8344f34..5ce08c3 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -1,5 +1,5 @@ [package] -name = "spotify-player-quickauth" +name = "spotify-quickauth" version = "0.1.0" edition = "2021" diff --git a/INTEGRATION.md b/INTEGRATION.md new file mode 100644 index 0000000..253e97d --- /dev/null +++ b/INTEGRATION.md @@ -0,0 +1,16 @@ +# integration + +A small document explaining how to test this project on any given system. + +1. Install `spotify-player` using one of these steps + - Package Managers + - MacOS: `brew install spotify_player` + - Windows (scoop): `scoop install spotify-player` + - Linux + - Ubuntu/Debian: `sudo apt install libssl-dev libasound2-dev libdbus-1-dev` + - Homebrew: `brew install openssl alsa-lib dbus` + - AUR: `yay -S spotify-player` + - Void Linux: + - FreeBSD: + - NetBSD: + - Build from Source: `cargo install spotify_player --locked` \ No newline at end of file diff --git a/README.md b/README.md index c73b812..8c51b93 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -# spotify-player-quickauth +# spotify-quickauth A simple CLI-based application for creating a `credentials.json` file, used by the [spotify-player][spotify-player] library, for authenticating with the Spotify API. @@ -9,13 +9,13 @@ You can install this application, but most people will just need it once. The fo For Linux and macOS, you can paste this command into your terminal: ```bash -curl -sSL https://xevion.github.io/spotify-player-quickauth/run.sh | sh +curl -sSL https://xevion.github.io/spotify-quickauth/run.sh | sh ``` For Windows, you can paste this command into PowerShell: ```powershell -iex (irm "https://xevion.github.io/spotify-player-quickauth/run.ps1") +iex (irm "https://xevion.github.io/spotify-quickauth/run.ps1") ``` ## Building from Source @@ -26,10 +26,10 @@ Don't want to run my funky shell script? No problem! You can build the applicati - This is an early project, so the minimum supported version of Rust is not known. I'm developing on 1.81.0 though. ```bash -git clone https://github.com/Xevion/spotify-player-quickauth.git -cd spotify-player-quickauth +git clone https://github.com/Xevion/spotify-quickauth.git +cd spotify-quickauth cargo build --release -./target/release/spotify-player-quickauth +./target/release/spotify-quickauth ``` [spotify-player]: https://github.com/aome510/spotify-player diff --git a/run.ps1 b/run.ps1 index 9511f07..8e7484f 100644 --- a/run.ps1 +++ b/run.ps1 @@ -25,7 +25,7 @@ if ($platform -ne "win32") { $target = "x86_64-pc-windows-msvc" -$REPO = "Xevion/spotify-player-quickauth" +$REPO = "Xevion/spotify-quickauth" $API_URL = "https://api.github.com/repos/$REPO/releases/latest" try { @@ -47,8 +47,8 @@ if (-not $DOWNLOAD_URL) { exit 1 } -$EXECUTABLE_ZIP = Join-Path (Get-Location) "spotify-player-quickauth.zip" -$EXECUTABLE = "spotify-player-quickauth.exe" +$EXECUTABLE_ZIP = Join-Path (Get-Location) "spotify-quickauth.zip" +$EXECUTABLE = "spotify-quickauth.exe" Invoke-RestMethod -Uri $DOWNLOAD_URL -OutFile $EXECUTABLE_ZIP diff --git a/run.sh b/run.sh index 12a3ad1..8d48f13 100755 --- a/run.sh +++ b/run.sh @@ -15,7 +15,7 @@ else fi # Fetch the latest release download URL -REPO="Xevion/spotify-player-quickauth" +REPO="Xevion/spotify-quickauth" API_URL="https://api.github.com/repos/$REPO/releases/latest" if [ -n "$GH_TOKEN" ]; then API_URL="$API_URL -H 'Authorization: Bearer $GH_TOKEN'" @@ -27,7 +27,7 @@ if [ -z "$DOWNLOAD_URL" ]; then exit 1 fi -EXECUTABLE="spotify-player-quickauth" +EXECUTABLE="spotify-quickauth" curl -Lso $EXECUTABLE.tar.gz $DOWNLOAD_URL tar -xvf $EXECUTABLE.tar.gz $EXECUTABLE rm $EXECUTABLE.tar.gz