Release V4 Release Candidate 1

Release V4 Release Candidate 1

.editorconfig

@@ -14,7 +14,7 @@ charset = utf-8
 max_line_length = 100
 
 [*.json]
-indent_size = 2
+indent_size = 4
 
 [{*.yml, *.yaml}]
 indent_size = 2

.gitattributes

@@ -1,36 +1,36 @@
 # Set the default behavior, in case people don't have core.autocrlf set.
-*          text=auto eol=lf
+* text=auto eol=lf
 
 # Explicitly declare text files you want to always be normalized and converted
 # to native line endings on checkout.
-*.py       text diff=python
+*.py text diff=python
 
 # Documents
-*.md       text diff=markdown
+*.md text diff=markdown
 
 # Graphics
-*.png      binary
-*.jpg      binary
-*.jpeg     binary
-*.gif      binary
-*.svg      text
+*.png binary
+*.jpg binary
+*.jpeg binary
+*.gif binary
+*.svg text
 
 # Scripts
-*.bash     text eol=lf
-*.fish     text eol=lf
-*.sh       text eol=lf
+*.bash text eol=lf
+*.fish text eol=lf
+*.sh text eol=lf
 # These are explicitly windows files and should use crlf
-*.bat      text eol=crlf
-*.cmd      text eol=crlf
+*.bat text eol=crlf
+*.cmd text eol=crlf
 
 # Serialisation
-*.json     text
-*.toml     text
-*.xml      text
-*.yaml     text
-*.yml      text
+*.json text
+*.toml text
+*.xml text
+*.yaml text
+*.yml text
 
 # Exclude files from exporting
 .gitattributes export-ignore
-.gitignore     export-ignore
-.gitkeep       export-ignore
+.gitignore export-ignore
+.gitkeep export-ignore

.github/ISSUE_TEMPLATE/bug_report.yml

@@ -1,4 +1,4 @@
-name: Bug Report 
+name: Bug Report
 
 title: Change this title, poorly formatted issues will not be handled
 
@@ -10,14 +10,15 @@ body:
 
 - type: dropdown
   attributes:
-    label: System Operating System (OS)
+    label: System OS
     description: OS not listed here? Please let us know below
     options:
       - Windows
       - MacOS
       - Linux
       - Docker
       - Termux (Android)
+      - Other
   validations:
     required: true
 
@@ -53,7 +54,7 @@ body:
     description: |
       Supply version if installed from pip, found via `pip show spotdl`
       or supply commit hash if installed from GitHub
-    placeholder: v3.x.x or hash-value
+    placeholder: v4.x.x or hash-value
   validations:
     required: true
 
@@ -64,10 +65,7 @@ body:
 
 - type: textarea
   attributes:
-    label: Steps to reproduce
-    description: |
-      Please ensure to include Spotify links and the actual command 
-      you used.
+    label: Steps to reproduce - Ensure to include actual links!
     placeholder: |
       1.
       2.
@@ -79,11 +77,12 @@ body:
 - type: textarea
   attributes:
     label: Traceback
-    description: Copy and paste the complete error message outputted by spotDL
+    description: Copy and paste the complete output from spotDL
     render: text
+    placeholder: Do this even if there is no error!
   validations:
     required: true
-    
+
 
 - type: textarea
   attributes:
@@ -92,4 +91,4 @@ body:
       Note anything else you can provide regarding the issue you're running into.
 
       If you didn't include your Python version, OS or installation source in the dropdowns
-      earlier, note said details here. 
+      earlier, note said details here.

.github/ISSUE_TEMPLATE/config.yml

@@ -4,4 +4,3 @@ contact_links:
   - name: spotDL Discord Server!
     url: https://discord.gg/xCa23pwJWY
     about: Join the spotDL Discord Server
-

.github/ISSUE_TEMPLATE/feature_request.yml

@@ -0,0 +1,21 @@
+name: Feature Request
+
+title: Change this title, poorly formatted issues will not be handled
+
+description: Request a new feature
+
+labels: feature-request
+
+body:
+
+- type: textarea
+  attributes:
+    label: Requested Feature
+    placeholder: Describe the feature you would like to see implemented!
+  validations:
+    required: true
+
+- type: textarea
+  attributes:
+    label: Possible implementation
+    placeholder: Describe a potential method of implementing this feature

.github/workflows/build-docs.yml

@@ -0,0 +1,37 @@
+name: Deploy docs to GitHub pages
+
+on:
+  push:
+    # branches to consider in the event; optional, defaults to all
+    branches:
+      - master
+      - dev
+
+jobs:
+  deploy:
+    if: "!contains(github.event.commits[0].message, '[skip ci]')"
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v3
+        with:
+          fetch-depth: 0
+          submodules: recursive
+
+      - name: Install poetry
+        run: pipx install poetry
+
+      - name: Set up Python 3.10
+        uses: actions/setup-python@v4
+        with:
+          python-version: "3.10"
+          cache: 'poetry'
+
+      - name: Install dependencies
+        run: |
+          poetry env use "3.10"
+          poetry install
+
+      - name: Build and deploy
+        run: |
+          poetry run mkdocs gh-deploy --force

.github/workflows/docker-hub-image-publish.yml

@@ -0,0 +1,26 @@
+name: Publish Docker image
+
+on:
+  release:
+    types:
+      - published
+
+jobs:
+  publish:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v2
+      - name: Set up Docker Buildx
+        uses: docker/setup-buildx-action@v1
+      - name: Login to DockerHub
+        uses: docker/login-action@v1
+        with:
+          username: ${{ secrets.DOCKER_HUB_USERNAME }}
+          password: ${{ secrets.DOCKER_HUB_PASSWORD }}
+      - name: Build and push
+        uses: docker/build-push-action@v2
+        with:
+          context: .
+          push: true
+          tags: spotdl/spotify-downloader:latest

.github/workflows/python-publish.yml

@@ -5,28 +5,107 @@ name: Upload Python Package
 
 on:
   release:
-    types: 
+    types:
       - published
-      
+
 jobs:
   deploy:
-
     runs-on: ubuntu-latest
 
     steps:
-    - uses: actions/checkout@v2
-    - name: Set up Python
-      uses: actions/setup-python@v2
-      with:
-        python-version: '3.x'
-    - name: Install dependencies
-      run: |
-        python -m pip install --upgrade pip
-        pip install setuptools wheel twine
-    - name: Build and publish
-      env:
-        TWINE_USERNAME: ${{ secrets.PYPI_USERNAME }}
-        TWINE_PASSWORD: ${{ secrets.PYPI_PASSWORD }}
-      run: |
-        python setup.py sdist bdist_wheel
-        twine upload dist/*
+      - uses: actions/checkout@v2
+        with:
+          fetch-depth: 0
+          submodules: recursive
+
+      - name: Install poetry
+        run: pipx install poetry
+
+      - name: Set up Python 3.10
+        uses: actions/setup-python@v4
+        with:
+          python-version: "3.10"
+          cache: 'poetry'
+
+      - name: Install dependencies
+        run: |
+          poetry env use "3.10"
+          poetry install
+
+      - name: Install twine
+        run: pip install twine
+
+      - name: Build
+        run: |
+          poetry build
+
+      - name: Publish on Pip
+        env:
+          TWINE_USERNAME: ${{ secrets.PYPI_USERNAME }}
+          TWINE_PASSWORD: ${{ secrets.PYPI_PASSWORD }}
+        run: twine upload dist/*
+
+  build:
+    strategy:
+      matrix:
+        platform: [ubuntu-latest, macos-latest, windows-latest]
+    runs-on: ${{ matrix.platform }}
+    steps:
+      - uses: actions/checkout@v3
+
+      - name: Install poetry
+        run: pipx install poetry
+
+      - name: Set up Python 3.10
+        uses: actions/setup-python@v4
+        with:
+          python-version: "3.10"
+          cache: 'poetry'
+
+      - name: Install dependencies
+        run: |
+          poetry env use "3.10"
+          poetry install
+
+      - name: Build executable
+        run: poetry run python ./scripts/build.py
+
+      - name: Release
+        uses: softprops/action-gh-release@v1
+        with:
+          files: |
+            dist/*
+
+  build-arm:
+    runs-on: ubuntu-latest
+    name: Build on ubuntu-latest aarch64
+    steps:
+      - uses: actions/checkout@v2
+      - uses: uraimo/run-on-arch-action@v2
+        name: Run commands
+        id: runcmd
+        with:
+          arch: aarch64
+          distro: ubuntu_latest
+
+          # Mount the artifacts directory as /artifacts in the container
+          dockerRunArgs: |
+            --volume "${PWD}/:/spotdl"
+
+          # The shell to run commands with in the container
+          shell: /bin/sh
+
+          run: |
+            cd /spotdl
+            apt update
+            apt install python3 python3-pip -y
+            pip install poetry
+            poetry install
+            poetry run python ./scripts/build.py
+            for file in dist/spotdl*; do cp "$file" "${file}-aarch64"; done
+
+      - name: Release
+        uses: softprops/action-gh-release@v1
+        with:
+          files: |
+            dist/spotdl*