From b962c58908db8a3d3ca1f8b57648d399656face2 Mon Sep 17 00:00:00 2001 From: Ashley Bailey Date: Fri, 6 Oct 2023 07:35:22 +0100 Subject: [PATCH 1/9] Delete .github/workflows directory --- .github/workflows/beta-release.yml | 66 ------------------------------ .github/workflows/docker-build.yml | 46 --------------------- 2 files changed, 112 deletions(-) delete mode 100644 .github/workflows/beta-release.yml delete mode 100644 .github/workflows/docker-build.yml diff --git a/.github/workflows/beta-release.yml b/.github/workflows/beta-release.yml deleted file mode 100644 index fd863bc5e..000000000 --- a/.github/workflows/beta-release.yml +++ /dev/null @@ -1,66 +0,0 @@ -name: Create Pre-Release on Version Change - -on: - push: - branches: - - v3-beta - -jobs: - check-version-and-create-release: - runs-on: ubuntu-latest - - steps: - - name: Checkout code - uses: actions/checkout@v2 - - - name: Set up Node.js - uses: actions/setup-node@v2 - with: - node-version: "14" - - - name: Install dependencies - run: npm install - - - name: Get previous package version - id: get_prev_version - run: echo "::set-output name=prev_version::$(git show HEAD^:package.json | jq -r '.version')" - - - name: Get current package version - id: get_current_version - run: echo "::set-output name=current_version::$(jq -r '.version' package.json)" - - - name: Compare versions - id: compare_versions - run: | - if [[ "${{ steps.get_prev_version.outputs.prev_version }}" != "${{ steps.get_current_version.outputs.current_version }}" ]]; then - echo "Version changed. Creating Pre-Release." - echo "New version: ${{ steps.get_current_version.outputs.current_version }}, Previous version: ${{ steps.get_prev_version.outputs.prev_version }}" - echo "::set-output name=version_changed::true" - else - echo "Version unchanged. No Pre-Release needed." - echo "::set-output name=version_changed::false" - fi - - - name: Generate Release Notes - id: generate_release_notes - run: | - echo "::set-output name=release_notes::$(git log --pretty=format:"- %s%n" $(git rev-list ${{ github.event.before }}..${{ github.sha }}))" - - - name: Create Pre-Release - if: steps.compare_versions.outputs.version_changed == 'true' - env: - GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} - run: | - # Create a new Pre-Release using GitHub API - # Replace ":owner", ":repo", and other placeholders with actual values - # You can use curl or other tools to interact with the API - curl -X POST \ - -H "Authorization: token $GITHUB_TOKEN" \ - -d '{ - "tag_name": "'${{ steps.get_current_version.outputs.current_version }}'", - "target_commitish": "v3-beta", - "name": "Pre-Release V'${{ steps.get_current_version.outputs.current_version }}'", - "body": "${{ steps.generate_release_notes.outputs.release_notes }}", - "prerelease": true - }' \ - "https://api.github.com/repos/wizarrrr/wizarr/releases" diff --git a/.github/workflows/docker-build.yml b/.github/workflows/docker-build.yml deleted file mode 100644 index bfffe357e..000000000 --- a/.github/workflows/docker-build.yml +++ /dev/null @@ -1,46 +0,0 @@ -name: Docker Build and Push - -on: - push: - branches: - - v3-beta - -permissions: - packages: write - -env: - REGISTRY: ghcr.io - IMAGE_NAME: wizarrrr/wizarr - IMAGE_TAG: v3-beta - -jobs: - build: - runs-on: ubuntu-latest - steps: - # Checkout the repo - - name: Checkout - uses: actions/checkout@v2 - - # Set up Docker Buildx - - name: Set up Docker Buildx - id: buildx - uses: docker/setup-buildx-action@v3 - - # Login to GHCR - - name: Login to GHCR - uses: docker/login-action@v1 - with: - registry: ${{ env.REGISTRY }} - username: ${{ github.actor }} - password: ${{ secrets.GITHUB_TOKEN }} - - # Build and push the image - - name: Build and push - uses: docker/build-push-action@v5 - with: - context: . - file: ./Dockerfile - push: true - tags: ${{ env.REGISTRY }}/${{ env.IMAGE_NAME }}:${{ env.IMAGE_TAG }} - platforms: linux/amd64,linux/arm64,linux/arm64/v7,linux/arm64/v8 - provenance: false From 1d51b629704355ee3db85f25aa13c498b4bdc297 Mon Sep 17 00:00:00 2001 From: Ashley Date: Fri, 6 Oct 2023 07:43:47 +0100 Subject: [PATCH 2/9] Delete unnecessary files and templates for bug reporting. --- .github/FUNDING.yml | 4 ---- .github/ISSUE_TEMPLATE/bug_report.md | 24 ------------------------ .github/ISSUE_TEMPLATE/not-working.md | 24 ------------------------ 3 files changed, 52 deletions(-) delete mode 100644 .github/FUNDING.yml delete mode 100644 .github/ISSUE_TEMPLATE/bug_report.md delete mode 100644 .github/ISSUE_TEMPLATE/not-working.md diff --git a/.github/FUNDING.yml b/.github/FUNDING.yml deleted file mode 100644 index 11f91e1c7..000000000 --- a/.github/FUNDING.yml +++ /dev/null @@ -1,4 +0,0 @@ -# These are supported funding model platforms - -github: mtthidoteu -ko_fi: mtthidoteu diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md deleted file mode 100644 index f8831467c..000000000 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ /dev/null @@ -1,24 +0,0 @@ ---- -name: Bug report -about: Create a report to help us improve -title: "[BUG]" -labels: '' -assignees: '' - ---- - -**Describe the bug** -A clear and concise description of what the bug is. - -**Screenshots** -If applicable, add screenshots to help explain your problem. - - -**Logs** -If applicable, add logs to help explain your problem -``` -ERROR:ROOT:SOMETHING BAD -``` - -**Additional context** -Add any other context about the problem here. diff --git a/.github/ISSUE_TEMPLATE/not-working.md b/.github/ISSUE_TEMPLATE/not-working.md deleted file mode 100644 index 14122ec23..000000000 --- a/.github/ISSUE_TEMPLATE/not-working.md +++ /dev/null @@ -1,24 +0,0 @@ ---- -name: Not working -about: Not sure if it is a bug or a misconfiguration -title: "[HELP]" -labels: '' -assignees: '' - ---- - -**Describe the bug** -A clear and concise description of what the bug is. - -**Screenshots** -If applicable, add screenshots to help explain your problem. - - -**Logs** -If applicable, add logs to help explain your problem -``` -ERROR:ROOT:SOMETHING BAD -``` - -**Additional context** -Add any other context about the problem here. From 5f2bb35073be6947e95aa41cd87627c4079391d4 Mon Sep 17 00:00:00 2001 From: Ashley Date: Fri, 6 Oct 2023 07:02:19 +0100 Subject: [PATCH 3/9] Add Docker build and push workflow file and update README.md - Added a new Docker build and push workflow file to the `.github/workflows` directory. This file defines the build and push steps for Docker images. - Updated the `README.md` file to include information about Wizarr V2 moving to the v2 branch, the inability to upgrade from V2 to V3, and the current lack of documentation. --- .github/workflows/master-docker-build.yml | 68 +++++++++++++++++++++++ README.md | 26 +++++++-- 2 files changed, 90 insertions(+), 4 deletions(-) create mode 100644 .github/workflows/master-docker-build.yml diff --git a/.github/workflows/master-docker-build.yml b/.github/workflows/master-docker-build.yml new file mode 100644 index 000000000..4ed8c7974 --- /dev/null +++ b/.github/workflows/master-docker-build.yml @@ -0,0 +1,68 @@ +name: Docker Build and Push + +on: + push: + branches: + - "master" + tags: + - "v*.*.*" + pull_request: + branches: + - "master" + +permissions: + packages: write + +env: + REGISTRY: ghcr.io + IMAGE_NAME: wizarrrr/wizarr + +jobs: + build: + runs-on: ubuntu-latest + steps: + # Checkout the repo + - name: Checkout + uses: actions/checkout@v2 + + # Get Docker meta + - name: Docker meta + id: meta + uses: docker/metadata-action@v5 + with: + # list of Docker images to use as base name for tags + images: ${{ env.REGISTRY }}/${{ env.IMAGE_NAME }} + # generate Docker tags based on the following events/attributes + tags: | + type=schedule + type=ref,event=branch + type=ref,event=pr + type=semver,pattern={{version}} + type=semver,pattern={{major}}.{{minor}} + type=semver,pattern={{major}} + type=sha + + # Set up Docker Buildx + - name: Set up Docker Buildx + id: buildx + uses: docker/setup-buildx-action@v3 + + # Login to GHCR + - name: Login to GHCR + uses: docker/login-action@v1 + with: + registry: ${{ env.REGISTRY }} + username: ${{ github.actor }} + password: ${{ secrets.GITHUB_TOKEN }} + + # Build and push the image + - name: Build and push + uses: docker/build-push-action@v5 + with: + context: . + file: ./Dockerfile + push: ${{ github.event_name != 'pull_request' }} + tags: ${{ steps.meta.outputs.tags }} + platforms: linux/amd64,linux/arm64,linux/arm64/v7,linux/arm64/v8 + provenance: false + labels: ${{ steps.meta.outputs.labels }} diff --git a/README.md b/README.md index b1207f9b3..63f6356b2 100644 --- a/README.md +++ b/README.md @@ -4,7 +4,7 @@ ---

- +

@@ -40,6 +40,14 @@ Wizarr is a automatic user invitation system for Plex and Jellyfin. Create a unique link and share it to a user and they will be invited to your Media Server after they complete there signup proccess! They can even be guided to download the clients and read instructions on how to use your media software! +## Where is V2? + +Wizarr V2 has moved to the v2 branch [here](https://github.com/Wizarrrr/wizarr/tree/v2), your still more than welcome to use v2 however it will no longer be supported, we recommend using our new version, trust us it's 🔥. + +## V3 upgradable from V2? + +**NO**, we tried our best to make it work but V3 has too much awesomeness, please create a new container and use a **NEW DATABASE**, V3 does not require any env variables like V2 did, so please make sure to follow the below Compose or Docker configs exactly. + ## Major Features Include - Automatic Invitation to your Media Server (Plex, Jellyfin) @@ -79,7 +87,7 @@ docker run -d \ --name wizarr \ -p 5690:5690 \ -v ./wizarr/database:/data/database \ - ghcr.io/wizarrrr/wizarr:v3-beta + ghcr.io/wizarrrr/wizarr:latest ``` ``` @@ -88,15 +96,25 @@ version: "3.5" services: wizarr: container_name: wizarr - image: ghcr.io/wizarrrr/wizarr:v3-beta + image: ghcr.io/wizarrrr/wizarr:latest ports: - 5690:5690 volumes: - ./wizarr/database:/data/database ``` +## Documentation + +Our documentation is lacking since we upgraded from V2 to V3, we appologise for this and we welcome you to come onto our [Discord](https://discord.gg/XXCz7aM3ak) and ask for a member of staff, we would be happy to help. + +If you want to help contribute to Wizarr by building V3's documentation we would really appreciate it, again join the [Discord](https://discord.gg/XXCz7aM3ak) and we can get you started. + Check out our documentation for instructions on how to install and run Wizarr! -https://github.com/Wizarrrr/wizarr/tree/v3-beta/docs/setup +https://github.com/Wizarrrr/wizarr/docs/setup + + +Chat on Discord + ## Thank you From 1701f5e43a266696e418ba4ddaee245f5661470b Mon Sep 17 00:00:00 2001 From: Ashley Bailey Date: Fri, 6 Oct 2023 07:37:46 +0100 Subject: [PATCH 4/9] Update and rename beta-release.yml to beta-ci.yml --- .github/workflows/beta-ci.yml | 53 +++++++++++++++++++++++++++++++++++ 1 file changed, 53 insertions(+) create mode 100644 .github/workflows/beta-ci.yml diff --git a/.github/workflows/beta-ci.yml b/.github/workflows/beta-ci.yml new file mode 100644 index 000000000..6480cb18f --- /dev/null +++ b/.github/workflows/beta-ci.yml @@ -0,0 +1,53 @@ +name: Docker Build and Push + +on: + push: + branches: + - v3-beta + +permissions: + packages: write + +env: + REGISTRY: ghcr.io + IMAGE_NAME: wizarrrr/wizarr + IMAGE_TAG: v3-beta + +jobs: + build: + runs-on: ubuntu-latest + steps: + # Checkout the repo + - name: Checkout + uses: actions/checkout@v2 + + # Get the Release Version from .github/latest + - name: Get the Release Version from .github/latest + id: get_version + run: echo "::set-output name=version::$(cat .github/latest)" + + # Set up Docker Buildx + - name: Set up Docker Buildx + id: buildx + uses: docker/setup-buildx-action@v3 + + # Login to GHCR + - name: Login to GHCR + uses: docker/login-action@v1 + with: + registry: ${{ env.REGISTRY }} + username: ${{ github.actor }} + password: ${{ secrets.GITHUB_TOKEN }} + + # Build and push the image + - name: Build and push + uses: docker/build-push-action@v5 + with: + context: . + file: ./Dockerfile + push: true + tags: | + ${{ env.REGISTRY }}/${{ env.IMAGE_NAME }}:${{ env.IMAGE_TAG }} + ${{ env.REGISTRY }}/${{ env.IMAGE_NAME }}:${{ env.IMAGE_TAG }}-${{ steps.get_version.outputs.version }} + platforms: linux/amd64,linux/arm64,linux/arm64/v7,linux/arm64/v8 + provenance: false From 627e5b4a81016137a9952e68f70c3977a37d1c28 Mon Sep 17 00:00:00 2001 From: Ashley Bailey Date: Fri, 6 Oct 2023 07:38:12 +0100 Subject: [PATCH 5/9] Update and rename docker-build.yml to beta-release.yml --- .github/workflows/beta-release.yml | 63 ++++++++++++++++++++++++++++++ 1 file changed, 63 insertions(+) create mode 100644 .github/workflows/beta-release.yml diff --git a/.github/workflows/beta-release.yml b/.github/workflows/beta-release.yml new file mode 100644 index 000000000..96901dca2 --- /dev/null +++ b/.github/workflows/beta-release.yml @@ -0,0 +1,63 @@ +name: Pre-Release on Version Change + +on: + push: + branches: + - v3-beta + +jobs: + check-version-and-create-release: + runs-on: ubuntu-latest + steps: + # Checkout the repo + - name: Checkout code + uses: actions/checkout@v2 + + # Get the previous package version from .github/latest + - name: Get previous package version from .github/latest + id: get_prev_version + run: echo "::set-output name=prev_version::$(cat .github/latest)" + + # Get the current package version from .github/latest + - name: Get current package version + id: get_current_version + run: echo "::set-output name=current_version::$(cat .github/latest)" + + # Compare the previous and current versions + - name: Compare versions + id: compare_versions + run: | + if [[ "${{ steps.get_prev_version.outputs.prev_version }}" != "${{ steps.get_current_version.outputs.current_version }}" ]]; then + echo "Version changed. Creating Pre-Release." + echo "New version: ${{ steps.get_current_version.outputs.current_version }}, Previous version: ${{ steps.get_prev_version.outputs.prev_version }}" + echo "::set-output name=version_changed::true" + else + echo "Version unchanged. No Pre-Release needed." + echo "::set-output name=version_changed::false" + fi + + # Generate Release Notes + - name: Generate Release Notes + id: generate_release_notes + run: | + echo "::set-output name=release_notes::$(git log --pretty=format:"- %s%n" $(git rev-list ${{ github.event.before }}..${{ github.sha }}))" + + # Create Pre-Release + - name: Create Pre-Release + if: steps.compare_versions.outputs.version_changed == 'true' + env: + GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} + run: | + # Create a new Pre-Release using GitHub API + # Replace ":owner", ":repo", and other placeholders with actual values + # You can use curl or other tools to interact with the API + curl -X POST \ + -H "Authorization: token $GITHUB_TOKEN" \ + -d '{ + "tag_name": "'${{ steps.get_current_version.outputs.current_version }}'", + "target_commitish": "v3-beta", + "name": "Pre-Release V'${{ steps.get_current_version.outputs.current_version }}'", + "body": "${{ steps.generate_release_notes.outputs.release_notes }}", + "prerelease": true + }' \ + "https://api.github.com/repos/wizarrrr/wizarr/releases" From d93790661d20e54833c9f2c02523f56f2ce9be79 Mon Sep 17 00:00:00 2001 From: Ashley Bailey Date: Fri, 6 Oct 2023 07:38:33 +0100 Subject: [PATCH 6/9] Update and rename master-docker-build.yml to ci.yml --- .github/workflows/ci.yml | 70 +++++++++++++++++++++++ .github/workflows/master-docker-build.yml | 68 ---------------------- 2 files changed, 70 insertions(+), 68 deletions(-) create mode 100644 .github/workflows/ci.yml delete mode 100644 .github/workflows/master-docker-build.yml diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml new file mode 100644 index 000000000..251908a12 --- /dev/null +++ b/.github/workflows/ci.yml @@ -0,0 +1,70 @@ +name: Release Docker Image CI + +on: + release: + types: [created] + +permissions: + packages: write + +env: + REGISTRY: ghcr.io + IMAGE_NAME: wizarrrr/wizarr + +jobs: + build: + runs-on: ubuntu-latest + steps: + # Checkout the repo + - name: Checkout + uses: actions/checkout@v2 + + # Get the Release Version + - name: Get the Release Version + id: get_version + run: echo "::set-output name=version::${{ github.event.release.tag_name }}" + + # Do not build if the release is a pre-release + - name: Only if the release is not a pre-release + if: github.event.release.prerelease == true + run: exit 1 + + # Update .github/latest with the Release Version + - name: Update .github/latest with the Release Version + run: echo "${{ github.event.release.tag_name }}" > .github/latest + + # Commit the changes to .github/latest using token + - name: Commit the changes to .github/latest + run: | + git config user.name 'github-actions[bot]' + git config user.email 'github-actions[bot]@users.noreply.github.com' + git add .github/latest + git commit -m "Update .github/latest to ${{ github.event.release.tag_name }}" + git remote set-url origin https://x-access-token:${{ secrets.GITHUB_TOKEN }}@github.com/${{ github.repository }} + git push + + # Set up Docker Buildx + - name: Set up Docker Buildx + id: buildx + uses: docker/setup-buildx-action@v3 + + # Login to GHCR + - name: Login to GHCR + uses: docker/login-action@v1 + with: + registry: ${{ env.REGISTRY }} + username: ${{ github.actor }} + password: ${{ secrets.GITHUB_TOKEN }} + + # Build and push the image + - name: Build and push + uses: docker/build-push-action@v5 + with: + context: . + file: ./Dockerfile + push: true + platforms: linux/amd64,linux/arm64,linux/arm64/v7,linux/arm64/v8 + provenance: false + tags: | + ${{ env.REGISTRY }}/${{ env.IMAGE_NAME }}:latest + ${{ env.REGISTRY }}/${{ env.IMAGE_NAME }}:${{ steps.get_version.outputs.version }} diff --git a/.github/workflows/master-docker-build.yml b/.github/workflows/master-docker-build.yml deleted file mode 100644 index 4ed8c7974..000000000 --- a/.github/workflows/master-docker-build.yml +++ /dev/null @@ -1,68 +0,0 @@ -name: Docker Build and Push - -on: - push: - branches: - - "master" - tags: - - "v*.*.*" - pull_request: - branches: - - "master" - -permissions: - packages: write - -env: - REGISTRY: ghcr.io - IMAGE_NAME: wizarrrr/wizarr - -jobs: - build: - runs-on: ubuntu-latest - steps: - # Checkout the repo - - name: Checkout - uses: actions/checkout@v2 - - # Get Docker meta - - name: Docker meta - id: meta - uses: docker/metadata-action@v5 - with: - # list of Docker images to use as base name for tags - images: ${{ env.REGISTRY }}/${{ env.IMAGE_NAME }} - # generate Docker tags based on the following events/attributes - tags: | - type=schedule - type=ref,event=branch - type=ref,event=pr - type=semver,pattern={{version}} - type=semver,pattern={{major}}.{{minor}} - type=semver,pattern={{major}} - type=sha - - # Set up Docker Buildx - - name: Set up Docker Buildx - id: buildx - uses: docker/setup-buildx-action@v3 - - # Login to GHCR - - name: Login to GHCR - uses: docker/login-action@v1 - with: - registry: ${{ env.REGISTRY }} - username: ${{ github.actor }} - password: ${{ secrets.GITHUB_TOKEN }} - - # Build and push the image - - name: Build and push - uses: docker/build-push-action@v5 - with: - context: . - file: ./Dockerfile - push: ${{ github.event_name != 'pull_request' }} - tags: ${{ steps.meta.outputs.tags }} - platforms: linux/amd64,linux/arm64,linux/arm64/v7,linux/arm64/v8 - provenance: false - labels: ${{ steps.meta.outputs.labels }} From 57128a2649cb29a1069911a62750c1d39e6fa527 Mon Sep 17 00:00:00 2001 From: Ashley Bailey Date: Fri, 6 Oct 2023 07:39:17 +0100 Subject: [PATCH 7/9] Update FUNDING.yml --- .github/FUNDING.yml | 3 +++ 1 file changed, 3 insertions(+) create mode 100644 .github/FUNDING.yml diff --git a/.github/FUNDING.yml b/.github/FUNDING.yml new file mode 100644 index 000000000..7327c03c6 --- /dev/null +++ b/.github/FUNDING.yml @@ -0,0 +1,3 @@ +# These are supported funding model platforms + +open_collective: https://opencollective.com/wizarr From 99e268caa96cf24c51048e73e535d806e24fdf48 Mon Sep 17 00:00:00 2001 From: Ashley Bailey Date: Fri, 6 Oct 2023 07:39:46 +0100 Subject: [PATCH 8/9] Update FUNDING.yml --- .github/FUNDING.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/FUNDING.yml b/.github/FUNDING.yml index 7327c03c6..96dc75a60 100644 --- a/.github/FUNDING.yml +++ b/.github/FUNDING.yml @@ -1,3 +1,3 @@ # These are supported funding model platforms -open_collective: https://opencollective.com/wizarr +open_collective: wizarr From 0a065d7ca25fbce04a5dd3ba8146acd2f34eaf05 Mon Sep 17 00:00:00 2001 From: Ashley Date: Fri, 6 Oct 2023 07:32:55 +0100 Subject: [PATCH 9/9] feat: Update funding platforms and rename workflow files - Updated the funding platforms in `.github/FUNDING.yml`. - Renamed the workflow file `docker-build.yml` to `beta-ci.yml`. - Updated the Docker image tags in the `beta-ci.yml` workflow to include the release version. - Renamed the workflow file `master-docker-build.yml` to `ci.yml`. - Added a new workflow file `ci.yml` for releasing Docker images. - Updated the workflow status badge link in `README.md` to reflect the new workflow file name. --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 63f6356b2..fb0c18c47 100644 --- a/README.md +++ b/README.md @@ -32,7 +32,7 @@ Github Issue -Github Build +Github Build