diff --git a/.github/FUNDING.yml b/.github/FUNDING.yml deleted file mode 100644 index b6e5ee15..00000000 --- a/.github/FUNDING.yml +++ /dev/null @@ -1,12 +0,0 @@ -# These are supported funding model platforms - -github: [codetheweb] -patreon: # Replace with a single Patreon username -open_collective: # Replace with a single Open Collective username -ko_fi: # Replace with a single Ko-fi username -tidelift: # Replace with a single Tidelift platform-name/package-name e.g., npm/babel -community_bridge: # Replace with a single Community Bridge project-name e.g., cloud-foundry -liberapay: # Replace with a single Liberapay username -issuehunt: # Replace with a single IssueHunt username -otechie: # Replace with a single Otechie username -custom: # Replace with up to 4 custom sponsorship URLs e.g., ['link1', 'link2'] diff --git a/.github/dependabot.yml b/.github/dependabot.yml index a5012600..3f8f5b23 100644 --- a/.github/dependabot.yml +++ b/.github/dependabot.yml @@ -5,28 +5,4 @@ updates: schedule: interval: daily time: "10:00" - open-pull-requests-limit: 10 - ignore: - - dependency-name: "@types/node" - versions: - - 15.0.0 - - dependency-name: eslint-config-xo-typescript - versions: - - 0.37.0 - - 0.38.0 - - 0.39.0 - - dependency-name: husky - versions: - - 5.0.9 - - 5.1.0 - - 5.1.1 - - 5.1.2 - - 5.1.3 - - 5.2.0 - - dependency-name: "@types/spotify-web-api-node" - versions: - - 5.0.0 - - 5.0.1 - - dependency-name: "@discordjs/opus" - versions: - - 0.4.0 + open-pull-requests-limit: 10 \ No newline at end of file diff --git a/.github/workflows/lint.yml b/.github/workflows/lint.yml index 31ef0d4f..626ff86f 100644 --- a/.github/workflows/lint.yml +++ b/.github/workflows/lint.yml @@ -7,8 +7,8 @@ jobs: name: Lint runs-on: ubuntu-latest steps: - - uses: actions/checkout@v1 - - uses: actions/setup-node@v2 + - uses: actions/checkout@main + - uses: actions/setup-node@main with: node-version: '22' cache: 'yarn' diff --git a/.github/workflows/pr-release.yml b/.github/workflows/pr-release.yml index e121edd5..8189eab6 100644 --- a/.github/workflows/pr-release.yml +++ b/.github/workflows/pr-release.yml @@ -6,7 +6,7 @@ on: - completed env: - REGISTRY_IMAGE: ghcr.io/museofficial/muse + REGISTRY_IMAGE: ghcr.io/whytf/muse jobs: release-and-comment: @@ -19,17 +19,17 @@ jobs: id-token: write steps: - name: Login to GitHub Container Registry - uses: docker/login-action@v3 + uses: docker/login-action@master with: registry: ghcr.io username: ${{ github.repository_owner }} password: ${{ secrets.GITHUB_TOKEN }} - name: Set up Buildx - uses: docker/setup-buildx-action@v1 + uses: docker/setup-buildx-action@master - name: Download images - uses: actions/download-artifact@v4 + uses: actions/download-artifact@main with: path: /tmp/images pattern: image-linux-* @@ -44,7 +44,7 @@ jobs: docker load -i /tmp/images/image-linux-arm64.tar - name: Download SHA - uses: actions/download-artifact@v4 + uses: actions/download-artifact@main with: path: /tmp/SHA pattern: sha @@ -62,7 +62,7 @@ jobs: docker push ${{ env.REGISTRY_IMAGE }}:${{ env.SHA }}-linux-arm64 - name: Download Docker metadata - uses: actions/download-artifact@v4 + uses: actions/download-artifact@main with: path: /tmp/metadata pattern: metadata @@ -71,12 +71,12 @@ jobs: - name: Read the metadata.json file id: metadata_reader - uses: juliangruber/read-file-action@v1.0.0 + uses: juliangruber/read-file-action@master with: path: /tmp/metadata/metadata/metadata.json - name: Download PR number - uses: actions/download-artifact@v4 + uses: actions/download-artifact@main with: path: /tmp/pull_request_number pattern: pull_request_number @@ -93,7 +93,7 @@ jobs: docker buildx imagetools create $(cat /tmp/metadata/metadata/metadata.json | jq -cr '.tags | map("-t " + .) | join(" ")') ${{ env.REGISTRY_IMAGE }}:${{ env.SHA }}-linux-amd64 ${{ env.REGISTRY_IMAGE }}:${{ env.SHA }}-linux-arm64 - name: Create comment - uses: marocchino/sticky-pull-request-comment@v2 + uses: marocchino/sticky-pull-request-comment@main with: header: "pr-release" number: ${{ env.PR_NUMBER }} diff --git a/.github/workflows/pr-snapshot.yml b/.github/workflows/pr-snapshot.yml index 88182cb5..86ed7dba 100644 --- a/.github/workflows/pr-snapshot.yml +++ b/.github/workflows/pr-snapshot.yml @@ -3,7 +3,7 @@ name: Build snapshot of PR on: pull_request env: - REGISTRY_IMAGE: ghcr.io/museofficial/muse + REGISTRY_IMAGE: ghcr.io/whytf/muse jobs: build: @@ -12,12 +12,9 @@ jobs: matrix: runner-platform: - ubuntu-latest - - namespace-profile-default-arm64 include: - runner-platform: ubuntu-latest build-arch: linux/amd64 - - runner-platform: namespace-profile-default-arm64 - build-arch: linux/arm64 runs-on: ${{ matrix.runner-platform }} steps: - name: Prepare @@ -27,28 +24,28 @@ jobs: - name: Docker meta id: meta - uses: docker/metadata-action@v5 + uses: docker/metadata-action@master with: images: ${{ env.REGISTRY_IMAGE }} tags: type=ref,event=pr - name: Set up Buildx - uses: docker/setup-buildx-action@v3 + uses: docker/setup-buildx-action@master - name: Login to GitHub Container Registry - uses: docker/login-action@v3 + uses: docker/login-action@master with: registry: ghcr.io username: ${{ github.repository_owner }} password: ${{ secrets.GITHUB_TOKEN }} - name: Get current time - uses: josStorer/get-current-time@v2 + uses: josStorer/get-current-time@master id: current-time - name: Build id: build - uses: docker/build-push-action@v6 + uses: docker/build-push-action@master with: outputs: type=docker,dest=/tmp/image-${{ env.PLATFORM_PAIR }}.tar platforms: ${{ matrix.build-arch }} @@ -63,7 +60,7 @@ jobs: run: echo $DOCKER_METADATA_OUTPUT_JSON > /tmp/metadata.json - name: Upload metadata - uses: actions/upload-artifact@v4 + uses: actions/upload-artifact@main with: name: metadata path: /tmp/metadata.json @@ -74,14 +71,14 @@ jobs: echo "${{ github.sha }}" > /tmp/sha.txt - name: Upload SHA - uses: actions/upload-artifact@v4 + uses: actions/upload-artifact@main with: name: sha path: /tmp/sha.txt overwrite: true - name: Upload image - uses: actions/upload-artifact@v4 + uses: actions/upload-artifact@main with: name: image-${{ env.PLATFORM_PAIR }} path: /tmp/image-${{ env.PLATFORM_PAIR }}.tar diff --git a/.github/workflows/publish.yml b/.github/workflows/publish.yml index a279abe5..c6910bde 100644 --- a/.github/workflows/publish.yml +++ b/.github/workflows/publish.yml @@ -6,7 +6,7 @@ on: - 'v*' env: - REGISTRY_IMAGE: ghcr.io/museofficial/muse + REGISTRY_IMAGE: ghcr.io/whytf/muse jobs: publish: @@ -14,14 +14,10 @@ jobs: matrix: runner-platform: - ubuntu-latest - - namespace-profile-default-arm64 include: - runner-platform: ubuntu-latest build-arch: linux/amd64 tagged-platform: amd64 - - runner-platform: namespace-profile-default-arm64 - build-arch: linux/arm64 - tagged-platform: arm64 runs-on: ${{ matrix.runner-platform }} permissions: contents: read @@ -30,33 +26,25 @@ jobs: id-token: write steps: - name: Set up Buildx - uses: docker/setup-buildx-action@v3 - - - name: Login to DockerHub - uses: docker/login-action@v1 - with: - username: ${{ secrets.DOCKERHUB_USERNAME }} - password: ${{ secrets.DOCKERHUB_TOKEN }} + uses: docker/setup-buildx-action@master - name: Login to GitHub Container Registry - uses: docker/login-action@v3 + uses: docker/login-action@master with: registry: ghcr.io username: ${{ github.repository_owner }} password: ${{ secrets.GITHUB_TOKEN }} - name: Get current time - uses: josStorer/get-current-time@v2 + uses: josStorer/get-current-time@master id: current-time - name: Build and push id: docker_build - uses: docker/build-push-action@v6 + uses: docker/build-push-action@master with: push: true - tags: | - codetheweb/muse:${{ github.sha }}-${{ matrix.tagged-platform }} - ${{ env.REGISTRY_IMAGE }}:${{ github.sha }}-${{ matrix.tagged-platform }} + tags: ${{ env.REGISTRY_IMAGE }}:${{ github.sha }}-${{ matrix.tagged-platform }} platforms: ${{ matrix.build-arch }} build-args: | COMMIT_HASH=${{ github.sha }} @@ -72,55 +60,33 @@ jobs: attestations: write id-token: write steps: - - uses: actions/checkout@v1 + - uses: actions/checkout@main - name: Set up Buildx - uses: docker/setup-buildx-action@v1 - - - name: Login to DockerHub - uses: docker/login-action@v1 - with: - username: ${{ secrets.DOCKERHUB_USERNAME }} - password: ${{ secrets.DOCKERHUB_TOKEN }} + uses: docker/setup-buildx-action@master - name: Login to GitHub Container Registry - uses: docker/login-action@v3 + uses: docker/login-action@master with: registry: ghcr.io username: ${{ github.repository_owner }} password: ${{ secrets.GITHUB_TOKEN }} - - name: Get tags (Docker Hub) - id: get-tags-dockerhub - uses: Surgo/docker-smart-tag-action@v1 - with: - docker_image: codetheweb/muse - - name: Get tags (ghcr.io) id: get-tags-ghcr - uses: Surgo/docker-smart-tag-action@v1 + uses: Surgo/docker-smart-tag-action@main with: docker_image: ${{ env.REGISTRY_IMAGE }} - - name: Combine tags (Docker Hub) - run: docker buildx imagetools create $(echo '${{ steps.get-tags-dockerhub.outputs.tag }}' | tr "," "\0" | xargs -0 printf -- '-t %s ') 'codetheweb/muse:${{ github.sha }}-arm64' 'codetheweb/muse:${{ github.sha }}-amd64' - - name: Combine tags (GitHub Container Registry) run: docker buildx imagetools create $(echo '${{ steps.get-tags-ghcr.outputs.tag }}' | tr "," "\0" | xargs -0 printf -- '-t %s ') '${{ env.REGISTRY_IMAGE }}:${{ github.sha }}-arm64' '${{ env.REGISTRY_IMAGE }}:${{ github.sha }}-amd64' - - name: Update Docker Hub description - uses: peter-evans/dockerhub-description@v2.4.3 - with: - username: ${{ secrets.DOCKERHUB_USERNAME }} - password: ${{ secrets.DOCKERHUB_PASSWORD }} - repository: codetheweb/muse - release: name: Create GitHub release runs-on: ubuntu-latest needs: combine steps: - - uses: actions/checkout@v2 + - uses: actions/checkout@main - name: Get version from tag id: tag_name @@ -130,13 +96,13 @@ jobs: - name: Get Changelog Entry id: changelog_reader - uses: mindsers/changelog-reader-action@v2 + uses: mindsers/changelog-reader-action@master with: version: ${{ steps.tag_name.outputs.current_version }} path: ./CHANGELOG.md - name: Create/update release - uses: ncipollo/release-action@v1 + uses: ncipollo/release-action@main with: tag: v${{ steps.changelog_reader.outputs.version }} name: Release v${{ steps.changelog_reader.outputs.version }} diff --git a/.github/workflows/release-comment.yml b/.github/workflows/release-comment.yml index af122e7d..e47b15db 100644 --- a/.github/workflows/release-comment.yml +++ b/.github/workflows/release-comment.yml @@ -6,7 +6,7 @@ jobs: release: runs-on: ubuntu-latest steps: - - uses: apexskier/github-release-commenter@v1 + - uses: apexskier/github-release-commenter@main with: GITHUB_TOKEN: ${{ secrets.GH_PAT }} comment-template: | diff --git a/.github/workflows/type-check.yml b/.github/workflows/type-check.yml index 7f9cc659..71c7f758 100644 --- a/.github/workflows/type-check.yml +++ b/.github/workflows/type-check.yml @@ -7,8 +7,8 @@ jobs: name: Type Check runs-on: ubuntu-latest steps: - - uses: actions/checkout@v1 - - uses: actions/setup-node@v2 + - uses: actions/checkout@main + - uses: actions/setup-node@main with: node-version: '22' cache: 'yarn' diff --git a/README.md b/README.md index d22400ec..ea7e4365 100644 --- a/README.md +++ b/README.md @@ -1,13 +1,7 @@

- +

-> [!WARNING] -> I ([@codetheweb](https://github.com/codetheweb)) am no longer the primary maintainer of Muse. **If you use the Docker image, update your image source to `ghcr.io/museofficial/muse`.** We are currently publishing new releases to both `ghcr.io/museofficial/muse` and `codetheweb/muse`, but this may change in the future. -> Thank you to all the people who stepped up to help maintain Muse! - ------- - Muse is a **highly-opinionated midwestern self-hosted** Discord music bot **that doesn't suck**. It's made for small to medium-sized Discord servers/guilds (think about a group the size of you, your friends, and your friend's friends). ![Hero graphic](.github/hero.png) @@ -41,7 +35,7 @@ A 64-bit OS is required to run Muse. The `master` branch acts as the developing / bleeding edge branch and is not guaranteed to be stable. -When running a production instance, I recommend that you use the [latest release](https://github.com/museofficial/muse/releases/). +When running a production instance, I recommend that you use the [latest release](https://github.com/whytf/muse/releases/). ### 🐳 Docker @@ -55,7 +49,7 @@ There are a variety of image tags available: (Replace empty config strings with correct values.) ```bash -docker run -it -v "$(pwd)/data":/data -e DISCORD_TOKEN='' -e SPOTIFY_CLIENT_ID='' -e SPOTIFY_CLIENT_SECRET='' -e YOUTUBE_API_KEY='' ghcr.io/museofficial/muse:latest +docker run -it -v "$(pwd)/data":/data -e DISCORD_TOKEN='' -e SPOTIFY_CLIENT_ID='' -e SPOTIFY_CLIENT_SECRET='' -e YOUTUBE_API_KEY='' ghcr.io/whytf/muse:latest ``` This starts Muse and creates a data directory in your current directory. @@ -67,7 +61,7 @@ You can also store your tokens in an environment file and make it available to y ```yaml services: muse: - image: ghcr.io/museofficial/muse:latest + image: ghcr.io/whytf/muse:latest restart: always volumes: - ./muse:/data @@ -84,13 +78,13 @@ services: * Node.js (18.17.0 or latest 18.xx.xx is required and latest 18.x.x LTS is recommended) (Version 18 due to opus dependency) * ffmpeg (4.1 or later) -1. `git clone https://github.com/museofficial/muse.git && cd muse` +1. `git clone https://github.com/whytf/muse.git && cd muse` 2. Copy `.env.example` to `.env` and populate with values 3. I recommend checking out a tagged release with `git checkout v[latest release]` 4. `yarn install` (or `npm i`) 5. `yarn start` (or `npm run start`) -**Note**: if you're on Windows, you may need to manually set the ffmpeg path. See [#345](https://github.com/museofficial/muse/issues/345) for details. +**Note**: if you're on Windows, you may need to manually set the ffmpeg path. See [#345](https://github.com/whytf/muse/issues/345) for details. ## ⚙️ Additional configuration (advanced) @@ -146,4 +140,3 @@ You can configure the bot to automatically turn down the volume when people are - `/config set-reduce-vol-when-voice true` - Enable automatic volume reduction - `/config set-reduce-vol-when-voice false` - Disable automatic volume reduction - `/config set-reduce-vol-when-voice-target ` - Set the target volume percentage when people speak (0-100, default is 70) -