From b7e8a06ad9a0135fa2de16bee772688e9a9bd470 Mon Sep 17 00:00:00 2001 From: ydkmlt84 Date: Thu, 3 Oct 2024 19:20:01 -0400 Subject: [PATCH 01/41] testing dev branch --- docs/Configuration.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/docs/Configuration.md b/docs/Configuration.md index b4b1641..66e96e7 100644 --- a/docs/Configuration.md +++ b/docs/Configuration.md @@ -1,3 +1,5 @@ +Test + All configuration is done inside the application, no extra config is required in files.
At first boot you will be redirected to the settings page. From fd5a6de30fbd9b89b88240cdeb09b734865d5d0d Mon Sep 17 00:00:00 2001 From: ydkmlt84 Date: Sat, 5 Oct 2024 23:42:30 -0400 Subject: [PATCH 02/41] adding API page --- docs/API.md | 2 ++ mkdocs.yml | 2 ++ 2 files changed, 4 insertions(+) create mode 100644 docs/API.md diff --git a/docs/API.md b/docs/API.md new file mode 100644 index 0000000..51e5206 --- /dev/null +++ b/docs/API.md @@ -0,0 +1,2 @@ +# Maintainerr API Documentation + diff --git a/mkdocs.yml b/mkdocs.yml index be18918..3824f6f 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -182,6 +182,8 @@ nav: - Community: - Introduction.md - Contributing.md + - API: + - API.md - Guides: - blog/index.md From 9f34d76e11a2425ea4e94f7eb35d9a2eedce10f3 Mon Sep 17 00:00:00 2001 From: ydkmlt84 Date: Sun, 6 Oct 2024 00:04:12 -0400 Subject: [PATCH 03/41] added critic markdown --- docs/API.md | 6 ++++++ docs/Installation.md | 2 +- mkdocs.yml | 1 + 3 files changed, 8 insertions(+), 1 deletion(-) diff --git a/docs/API.md b/docs/API.md index 51e5206..94832f7 100644 --- a/docs/API.md +++ b/docs/API.md @@ -1,2 +1,8 @@ # Maintainerr API Documentation +!!! info + These docs are currently not auto-generated, are all hand-jammed, and there may be errors. If something doesn't look right, please feel free to raise an [issue](https://github.com/ydkmlt84/Maintainerr_docs/issues) on [Github](https://github.com/ydkmlt84/maintainerr_docs). +## Public endpoints + +!!! note + \ No newline at end of file diff --git a/docs/Installation.md b/docs/Installation.md index a5c7dc7..0fcc0e6 100644 --- a/docs/Installation.md +++ b/docs/Installation.md @@ -6,7 +6,7 @@ The containers data location is set as /opt/data. A docker [volume][tooltip] is [tooltip]: https://docs.docker.com/storage/volumes/#start-a-container-with-a-volume "Click here to be taken to the Docker documentation page on volumes." -> !!! info +!!! info You have the option to define a User and Group ID for running the container. Maintainerr will utilize the user:group setting as it's running user (inside the container), and any files it generates within your host data volume will be associated with this designated user and group. If not explicitly specified, the default UID:GID is set to 1000:1000. See [Run](#run) and [Compose](#compose) below for examples. diff --git a/mkdocs.yml b/mkdocs.yml index 3824f6f..c562493 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -128,6 +128,7 @@ markdown_extensions: # - customization.md # - insiders/changelog/* # - docs/extensions/* + - pymdownx.critic - pymdownx.arithmatex: generic: true - pymdownx.betterem: From cd0333002ae0a8a8ead341577aaa5e7c8dd6355a Mon Sep 17 00:00:00 2001 From: ydkmlt84 Date: Sun, 6 Oct 2024 00:15:50 -0400 Subject: [PATCH 04/41] icons --- docs/API.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/API.md b/docs/API.md index 94832f7..6b43d70 100644 --- a/docs/API.md +++ b/docs/API.md @@ -4,5 +4,5 @@ ## Public endpoints -!!! note - \ No newline at end of file +!!! note "" + ==GET== From 7ee2fa26e83f0795ef571947cbcbefc0abb9fa07 Mon Sep 17 00:00:00 2001 From: ydkmlt84 Date: Sun, 6 Oct 2024 00:18:50 -0400 Subject: [PATCH 05/41] testing1 --- docs/API.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/API.md b/docs/API.md index 6b43d70..b50cbef 100644 --- a/docs/API.md +++ b/docs/API.md @@ -5,4 +5,4 @@ ## Public endpoints !!! note "" - ==GET== + ==GET== From 20dc974f5134481f50ea5682f791ae2c7fbb082a Mon Sep 17 00:00:00 2001 From: ydkmlt84 Date: Sun, 6 Oct 2024 00:23:26 -0400 Subject: [PATCH 06/41] test2 --- docs/API.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/API.md b/docs/API.md index b50cbef..6d6c231 100644 --- a/docs/API.md +++ b/docs/API.md @@ -5,4 +5,4 @@ ## Public endpoints !!! note "" - ==GET== + ==GET== From 666bcd789f8ad0528b1fe2ad0d17313c90995fda Mon Sep 17 00:00:00 2001 From: ydkmlt84 Date: Sun, 6 Oct 2024 00:28:10 -0400 Subject: [PATCH 07/41] testing empty button --- docs/API.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/API.md b/docs/API.md index 6d6c231..0669c25 100644 --- a/docs/API.md +++ b/docs/API.md @@ -5,4 +5,4 @@ ## Public endpoints !!! note "" - ==GET== + [GET](){.md-button} From 056e707f83cf11f2956885d0708bf29b994cc579 Mon Sep 17 00:00:00 2001 From: ydkmlt84 Date: Sun, 6 Oct 2024 00:49:24 -0400 Subject: [PATCH 08/41] test3 --- docs/API.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/API.md b/docs/API.md index 0669c25..10185c5 100644 --- a/docs/API.md +++ b/docs/API.md @@ -5,4 +5,4 @@ ## Public endpoints !!! note "" - [GET](){.md-button} + From 50e32dabd3ba094022dbbe1370a1a5b4f4ba4702 Mon Sep 17 00:00:00 2001 From: ydkmlt84 Date: Sun, 6 Oct 2024 00:57:52 -0400 Subject: [PATCH 09/41] testing action for dev branch --- docs/API.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/API.md b/docs/API.md index 10185c5..09cb0d5 100644 --- a/docs/API.md +++ b/docs/API.md @@ -5,4 +5,4 @@ ## Public endpoints !!! note "" - + Testing From fac562634a53512e02f3f514d27459073d6cd319 Mon Sep 17 00:00:00 2001 From: ydkmlt84 Date: Sun, 6 Oct 2024 01:00:10 -0400 Subject: [PATCH 10/41] testing action again --- docs/API.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/API.md b/docs/API.md index 09cb0d5..b1d9229 100644 --- a/docs/API.md +++ b/docs/API.md @@ -5,4 +5,4 @@ ## Public endpoints !!! note "" - Testing + == GET == From a736ceee3b6c2ce8fe9fb910de068db5ccf04aed Mon Sep 17 00:00:00 2001 From: ydkmlt84 Date: Sun, 6 Oct 2024 01:03:08 -0400 Subject: [PATCH 11/41] adding action to dev branch --- .github/workflows/ci_dev.yml | 45 ++++++++++++++++++++++++++++++++++++ .gitignore | 1 + 2 files changed, 46 insertions(+) create mode 100644 .github/workflows/ci_dev.yml diff --git a/.github/workflows/ci_dev.yml b/.github/workflows/ci_dev.yml new file mode 100644 index 0000000..15422e2 --- /dev/null +++ b/.github/workflows/ci_dev.yml @@ -0,0 +1,45 @@ +name: pushed_updates_dev +run-name: ${{ github.actor }} Update dev docs after changes are pushed. +on: + push: + branches: + - 'develop' + pull_request: + types: + - 'closed' + branches: + - 'develop' + workflow_dispatch: + inputs: + dry-run: + type: boolean + description: Turn this on to skip running the SSH script. + default: false + +jobs: + execute-command: + if: ${{ github.triggering_actor == github.repository_owner }} + name: Use tailscale to connect and execute command. + runs-on: ubuntu-24.04 + steps: + - name: Tailscale + uses: tailscale/github-action@v2 + with: + oauth-client-id: ${{ secrets.TS_OAUTH_CLIENT_ID }} + oauth-secret: ${{ secrets.TS_OAUTH_SECRET }} + tags: tag:ci + - name: showing dry-run input + run: echo ${{inputs.dry-run}} + shell: bash + - name: executing remote ssh commands using password + if: ${{ inputs.dry-run == false }} + uses: appleboy/ssh-action@v1.0.3 + with: + host: ${{ secrets.SSH_HOST_TS }} + username: ${{ secrets.SSH_USERNAME }} + password: ${{ secrets.SSH_PASSWORD }} + port: ${{ secrets.SSH_PORT }} + script_stop: true + script: /bin/sh /home/thatoneguy99/.docker/mkdocs/action_execute_dev.sh + + \ No newline at end of file diff --git a/.gitignore b/.gitignore index 4c6900d..995082d 100644 --- a/.gitignore +++ b/.gitignore @@ -1,3 +1,4 @@ .cache action_execute.sh ascii.txt +action_execute_dev.sh From 34596e369d49427ca358061f5e9c347f8e03422e Mon Sep 17 00:00:00 2001 From: ydkmlt84 Date: Thu, 10 Oct 2024 09:00:30 -0400 Subject: [PATCH 12/41] versioning --- mkdocs.yml | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/mkdocs.yml b/mkdocs.yml index c562493..23c74aa 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -110,7 +110,8 @@ extra: link: https://hub.docker.com/r/jorenn92/maintainerr/ - icon: fontawesome/brands/discord link: https://discord.gg/WP4ZW2QYwk - + version: + provider: mike # Extensions markdown_extensions: - abbr From ee25506dbfaf3d133b78a25bf4d5b1314e277e18 Mon Sep 17 00:00:00 2001 From: ydkmlt84 Date: Thu, 10 Oct 2024 11:02:34 -0400 Subject: [PATCH 13/41] tautulli and dev clarification --- docs/Configuration.md | 2 +- docs/Glossary.md | 2 +- docs/Installation.md | 10 +++++++++- docs/Introduction.md | 2 +- 4 files changed, 12 insertions(+), 4 deletions(-) diff --git a/docs/Configuration.md b/docs/Configuration.md index 66e96e7..f8948f9 100644 --- a/docs/Configuration.md +++ b/docs/Configuration.md @@ -56,7 +56,7 @@ Sonarr's configuration is required to use it's parameters in rules and to remove | Port | The port Sonarr runs on | | Api key | Sonarr API key, should be visible in the Sonarr settings | -## Tautulli +## Tautulli (currently only available in the dev branch) Tautulli's configuration is required to use it's parameters in rules. diff --git a/docs/Glossary.md b/docs/Glossary.md index 5903fc8..6e3be22 100644 --- a/docs/Glossary.md +++ b/docs/Glossary.md @@ -510,7 +510,7 @@ The key is used for identification in Yaml rule files. - Availability: movies, shows, seasons, episodes - Type: boolean -### Tautulli +### Tautulli (currently only available in the dev branch) #### Viewed by (username) diff --git a/docs/Installation.md b/docs/Installation.md index 0fcc0e6..fd0785c 100644 --- a/docs/Installation.md +++ b/docs/Installation.md @@ -50,10 +50,14 @@ The containers data location is set as /opt/data. A docker [volume][tooltip] is -p 6246:6246 \ # (1)! --restart unless-stopped \ ghcr.io/jorenn92/maintainerr:latest # (2)! + # ghcr.io/jorenn92/maintainerr:main for the develop branch # (3)! + # jorenn92/maintainerr:develop for the Docker Hub + development image # (3)! ``` 1. This is defined as `host:container`. 2. For this line, you could also use `jorenn92/maintainerr` instead, to use the DockerHub image. The `latest` tag at the end is not required, unless you want to specify which tag to use. +3. The develop branch could be unstable. ### Updating @@ -83,7 +87,10 @@ version: '3' services: maintainerr: image: ghcr.io/jorenn92/maintainerr:latest # (1)! - container_name: maintainerr + # ghcr.io/jorenn92/maintainerr:main for the develop + branch # (3)! + # jorenn92/maintainerr:develop for the Docker Hub + container_name: maintainerr # (3)! user: 1000:1000 volumes: - type: bind @@ -99,6 +106,7 @@ services: 1. For this line, you could also use `jorenn92/maintainerr` instead, to use the DockerHub image. The `latest` tag at the end is not required, unless you want to specify which tag to use. 2. This is defined as `host:container`. +3. The develop branch could be unstable. Save your docker-compose.yml file. Then, while in the directory where your docker-compose file exists, start all services defined in your Compose file: diff --git a/docs/Introduction.md b/docs/Introduction.md index 5afdb08..3c83499 100644 --- a/docs/Introduction.md +++ b/docs/Introduction.md @@ -38,4 +38,4 @@ Maintainerr supports rules across these apps : - Overseerr - Radarr - Sonarr -- Tautulli +- Tautulli (currently available in the dev branch) From fc1babae3a7ae3c2484a6ecab01e5f0b5a2cf080 Mon Sep 17 00:00:00 2001 From: ydkmlt84 Date: Thu, 10 Oct 2024 11:10:07 -0400 Subject: [PATCH 14/41] run and compose instructions --- docs/Installation.md | 9 +++------ 1 file changed, 3 insertions(+), 6 deletions(-) diff --git a/docs/Installation.md b/docs/Installation.md index fd0785c..3d388de 100644 --- a/docs/Installation.md +++ b/docs/Installation.md @@ -51,8 +51,7 @@ The containers data location is set as /opt/data. A docker [volume][tooltip] is --restart unless-stopped \ ghcr.io/jorenn92/maintainerr:latest # (2)! # ghcr.io/jorenn92/maintainerr:main for the develop branch # (3)! - # jorenn92/maintainerr:develop for the Docker Hub - development image # (3)! + # jorenn92/maintainerr:develop for the Docker Hub development image # (3)! ``` 1. This is defined as `host:container`. @@ -87,10 +86,8 @@ version: '3' services: maintainerr: image: ghcr.io/jorenn92/maintainerr:latest # (1)! - # ghcr.io/jorenn92/maintainerr:main for the develop - branch # (3)! - # jorenn92/maintainerr:develop for the Docker Hub - container_name: maintainerr # (3)! + # ghcr.io/jorenn92/maintainerr:main for the develop branch # (3)! + # jorenn92/maintainerr:develop for the Docker Hub container_name: maintainerr # (3)! user: 1000:1000 volumes: - type: bind From 3de2ddc643c760c36d3f4d771c2242d3a2be3ad2 Mon Sep 17 00:00:00 2001 From: ydkmlt84 Date: Thu, 10 Oct 2024 11:15:17 -0400 Subject: [PATCH 15/41] drop down menus --- docs/Installation.md | 13 ++++++++----- 1 file changed, 8 insertions(+), 5 deletions(-) diff --git a/docs/Installation.md b/docs/Installation.md index 3d388de..e7582e5 100644 --- a/docs/Installation.md +++ b/docs/Installation.md @@ -50,14 +50,16 @@ The containers data location is set as /opt/data. A docker [volume][tooltip] is -p 6246:6246 \ # (1)! --restart unless-stopped \ ghcr.io/jorenn92/maintainerr:latest # (2)! - # ghcr.io/jorenn92/maintainerr:main for the develop branch # (3)! - # jorenn92/maintainerr:develop for the Docker Hub development image # (3)! ``` 1. This is defined as `host:container`. 2. For this line, you could also use `jorenn92/maintainerr` instead, to use the DockerHub image. The `latest` tag at the end is not required, unless you want to specify which tag to use. 3. The develop branch could be unstable. +??? info "Development Images" + ghcr.io/jorenn92/maintainerr:main for the develop branch + jorenn92/maintainerr:develop for the Docker Hub container_name: maintainerr + ### Updating Stop and remove the existing container: @@ -86,8 +88,6 @@ version: '3' services: maintainerr: image: ghcr.io/jorenn92/maintainerr:latest # (1)! - # ghcr.io/jorenn92/maintainerr:main for the develop branch # (3)! - # jorenn92/maintainerr:develop for the Docker Hub container_name: maintainerr # (3)! user: 1000:1000 volumes: - type: bind @@ -103,7 +103,10 @@ services: 1. For this line, you could also use `jorenn92/maintainerr` instead, to use the DockerHub image. The `latest` tag at the end is not required, unless you want to specify which tag to use. 2. This is defined as `host:container`. -3. The develop branch could be unstable. + +??? info "Development Images" + ghcr.io/jorenn92/maintainerr:main for the develop branch + jorenn92/maintainerr:develop for the Docker Hub container_name: maintainerr Save your docker-compose.yml file. Then, while in the directory where your docker-compose file exists, start all services defined in your Compose file: From 7583dfc197a7924ec74e78a8ffb6627705a67635 Mon Sep 17 00:00:00 2001 From: ydkmlt84 Date: Thu, 10 Oct 2024 11:19:28 -0400 Subject: [PATCH 16/41] dropdown syntax --- docs/Installation.md | 14 ++++++++------ 1 file changed, 8 insertions(+), 6 deletions(-) diff --git a/docs/Installation.md b/docs/Installation.md index e7582e5..71a952e 100644 --- a/docs/Installation.md +++ b/docs/Installation.md @@ -56,9 +56,10 @@ The containers data location is set as /opt/data. A docker [volume][tooltip] is 2. For this line, you could also use `jorenn92/maintainerr` instead, to use the DockerHub image. The `latest` tag at the end is not required, unless you want to specify which tag to use. 3. The develop branch could be unstable. -??? info "Development Images" - ghcr.io/jorenn92/maintainerr:main for the develop branch - jorenn92/maintainerr:develop for the Docker Hub container_name: maintainerr +??? note "Development Images" + `ghcr.io/jorenn92/maintainerr:main` for the develop branch + + 'jorenn92/maintainerr:develop' for the Docker Hub development image. ### Updating @@ -104,9 +105,10 @@ services: 1. For this line, you could also use `jorenn92/maintainerr` instead, to use the DockerHub image. The `latest` tag at the end is not required, unless you want to specify which tag to use. 2. This is defined as `host:container`. -??? info "Development Images" - ghcr.io/jorenn92/maintainerr:main for the develop branch - jorenn92/maintainerr:develop for the Docker Hub container_name: maintainerr +??? note "Development Images" + `ghcr.io/jorenn92/maintainerr:main` for the develop branch + + `jorenn92/maintainerr:develop` for the Docker Hub development image Save your docker-compose.yml file. Then, while in the directory where your docker-compose file exists, start all services defined in your Compose file: From 899b828295175b2d5d3a1e43fc74f3835065b380 Mon Sep 17 00:00:00 2001 From: ydkmlt84 Date: Thu, 10 Oct 2024 11:38:05 -0400 Subject: [PATCH 17/41] making new status icon --- docs/Common.md | 4 +++- docs/Installation.md | 12 +++++------- mkdocs.yml | 5 +++-- 3 files changed, 11 insertions(+), 10 deletions(-) diff --git a/docs/Common.md b/docs/Common.md index 6b56b21..f6f1f68 100644 --- a/docs/Common.md +++ b/docs/Common.md @@ -1,4 +1,6 @@ - +--- +status: new +--- > !!! info These are not going to solve *every* problem and the suggested solutions might not correct your problem. If you have tried what is laid out here and it still isn't working as expected. Please reach out on [Discord](https://discord.gg/WP4ZW2QYwk). diff --git a/docs/Installation.md b/docs/Installation.md index 71a952e..df88976 100644 --- a/docs/Installation.md +++ b/docs/Installation.md @@ -57,9 +57,8 @@ The containers data location is set as /opt/data. A docker [volume][tooltip] is 3. The develop branch could be unstable. ??? note "Development Images" - `ghcr.io/jorenn92/maintainerr:main` for the develop branch - - 'jorenn92/maintainerr:develop' for the Docker Hub development image. + - `ghcr.io/jorenn92/maintainerr:main` for the develop branch + - `jorenn92/maintainerr:develop` for the Docker Hub development image. ### Updating @@ -106,9 +105,8 @@ services: 2. This is defined as `host:container`. ??? note "Development Images" - `ghcr.io/jorenn92/maintainerr:main` for the develop branch - - `jorenn92/maintainerr:develop` for the Docker Hub development image + - `ghcr.io/jorenn92/maintainerr:main` for the develop branch + - `jorenn92/maintainerr:develop` for the Docker Hub development image. Save your docker-compose.yml file. Then, while in the directory where your docker-compose file exists, start all services defined in your Compose file: @@ -131,4 +129,4 @@ Then, restart all services defined in the Compose file: docker compose up -d ``` -:material-clock-edit: Last Updated: 5/31/24 +:material-clock-edit: Last Updated: 10/10/24 diff --git a/mkdocs.yml b/mkdocs.yml index 23c74aa..d2316e7 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -110,8 +110,9 @@ extra: link: https://hub.docker.com/r/jorenn92/maintainerr/ - icon: fontawesome/brands/discord link: https://discord.gg/WP4ZW2QYwk - version: - provider: mike + status: + new: Recently Added + deprecated: Deprecated # Extensions markdown_extensions: - abbr From cb9bfa3ec3aad26f8b5beec67f3872db57cc8d89 Mon Sep 17 00:00:00 2001 From: ydkmlt84 Date: Thu, 10 Oct 2024 13:48:34 -0400 Subject: [PATCH 18/41] added last updated to bottom --- docs/API.md | 3 +++ docs/Collections.md | 3 +++ docs/Common.md | 4 +++- docs/Configuration.md | 2 +- docs/Contributing.md | 3 +++ docs/Glossary.md | 4 +++- docs/Introduction.md | 2 ++ 7 files changed, 18 insertions(+), 3 deletions(-) diff --git a/docs/API.md b/docs/API.md index b1d9229..9fb7060 100644 --- a/docs/API.md +++ b/docs/API.md @@ -6,3 +6,6 @@ !!! note "" == GET == + + +:material-clock-edit: Last Updated: 10/10/24 diff --git a/docs/Collections.md b/docs/Collections.md index 460ff49..10cfa5c 100644 --- a/docs/Collections.md +++ b/docs/Collections.md @@ -43,3 +43,6 @@ When media has exclusions, an `Excl` badge will be shown on the top-right side o - Maintainerr will never remove the collection from Plex if you specified a manual collection. - You could add media directly to the Plex collection within Plex. Maintainerr will sync Media with the Plex collection. (The Plex collection might not always be available in case you're using an automatic collection) + +:material-clock-edit: Last Updated: 10/10/24 + diff --git a/docs/Common.md b/docs/Common.md index f6f1f68..156ba43 100644 --- a/docs/Common.md +++ b/docs/Common.md @@ -57,4 +57,6 @@ Q. When I try to load the Community Rules I get a spinning circle and they never A. Some of these services are self-hosted and some are hosted elsewhere. There are downtimes, but we try to minimize them as much as possible. ??? example "See The Fix?" - There is a website where you can see the status of our services. https://status.maintainerr.info \ No newline at end of file + There is a website where you can see the status of our services. https://status.maintainerr.info + +:material-clock-edit: Last Updated: 10/10/24 diff --git a/docs/Configuration.md b/docs/Configuration.md index f8948f9..984b799 100644 --- a/docs/Configuration.md +++ b/docs/Configuration.md @@ -66,4 +66,4 @@ Tautulli's configuration is required to use it's parameters in rules. | Port | The port Tautulli runs on | | Api key | Tautulli API key, should be visible in the Tautulli settings | -:material-clock-edit: Last Updated: 9/30/24 \ No newline at end of file +:material-clock-edit: Last Updated: 10/10/24 \ No newline at end of file diff --git a/docs/Contributing.md b/docs/Contributing.md index 2cb92da..8f56f11 100644 --- a/docs/Contributing.md +++ b/docs/Contributing.md @@ -120,3 +120,6 @@ When adding new UI text, please try to adhere to the following guidelines: ## Attribution This contribution guide was inspired by the [Overseerr](https://github.com/sct/overseerr) contribution guide. + +:material-clock-edit: Last Updated: 10/10/24 + diff --git a/docs/Glossary.md b/docs/Glossary.md index 6e3be22..12a70b7 100644 --- a/docs/Glossary.md +++ b/docs/Glossary.md @@ -526,4 +526,6 @@ The key is used for identification in Yaml rule files. - Key: Tautulli.sw_allEpisodesSeenBy - Availability: shows, seasons -- Type: text[] \ No newline at end of file +- Type: text[] + +:material-clock-edit: Last Updated: 10/10/24 diff --git a/docs/Introduction.md b/docs/Introduction.md index 3c83499..00015be 100644 --- a/docs/Introduction.md +++ b/docs/Introduction.md @@ -39,3 +39,5 @@ Maintainerr supports rules across these apps : - Radarr - Sonarr - Tautulli (currently available in the dev branch) + +:material-clock-edit: Last Updated: 10/10/24 From 4eea2fda22d0efaa8fadb9fc6224b39f12ed63e8 Mon Sep 17 00:00:00 2001 From: ydkmlt84 Date: Thu, 10 Oct 2024 13:55:11 -0400 Subject: [PATCH 19/41] dev icons --- docs/Glossary.md | 2 +- docs/stylesheets/extra.css | 11 +++++++++++ mkdocs.yml | 2 ++ 3 files changed, 14 insertions(+), 1 deletion(-) create mode 100644 docs/stylesheets/extra.css diff --git a/docs/Glossary.md b/docs/Glossary.md index 12a70b7..ea82598 100644 --- a/docs/Glossary.md +++ b/docs/Glossary.md @@ -510,7 +510,7 @@ The key is used for identification in Yaml rule files. - Availability: movies, shows, seasons, episodes - Type: boolean -### Tautulli (currently only available in the dev branch) +### Tautulli :test_tube:{ .dev } #### Viewed by (username) diff --git a/docs/stylesheets/extra.css b/docs/stylesheets/extra.css new file mode 100644 index 0000000..7975805 --- /dev/null +++ b/docs/stylesheets/extra.css @@ -0,0 +1,11 @@ +@keyframes dev { + 0%, 40%, 80%, 100% { + transform: scale(1); + } + 20%, 60% { + transform: scale(1.15); + } + } + .dev { + animation: dev 1000ms infinite; + } \ No newline at end of file diff --git a/mkdocs.yml b/mkdocs.yml index d2316e7..9dee4c5 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -97,6 +97,8 @@ hooks: - docs/overrides/hooks/translations.py # Additional configuration +extra_css: + - stylesheets/extra.css extra: annotate: json: [.s2] From 96862c5252e6a5294d39100c394c3f378be0122d Mon Sep 17 00:00:00 2001 From: ydkmlt84 Date: Thu, 10 Oct 2024 13:59:21 -0400 Subject: [PATCH 20/41] still working on dev icon --- docs/Glossary.md | 2 +- docs/stylesheets/extra.css | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/Glossary.md b/docs/Glossary.md index ea82598..a966103 100644 --- a/docs/Glossary.md +++ b/docs/Glossary.md @@ -510,7 +510,7 @@ The key is used for identification in Yaml rule files. - Availability: movies, shows, seasons, episodes - Type: boolean -### Tautulli :test_tube:{ .dev } +### Tautulli :test_tube:{ .dev title="In dev branch only"} #### Viewed by (username) diff --git a/docs/stylesheets/extra.css b/docs/stylesheets/extra.css index 7975805..7cf63f9 100644 --- a/docs/stylesheets/extra.css +++ b/docs/stylesheets/extra.css @@ -7,5 +7,5 @@ } } .dev { - animation: dev 1000ms infinite; + animation: dev 1500ms infinite; } \ No newline at end of file From b5b4e7c778fcfb12f375e8625b78d2655a2eb03f Mon Sep 17 00:00:00 2001 From: ydkmlt84 Date: Thu, 10 Oct 2024 14:02:06 -0400 Subject: [PATCH 21/41] dev icon css changes --- docs/Introduction.md | 2 +- docs/stylesheets/extra.css | 1 + 2 files changed, 2 insertions(+), 1 deletion(-) diff --git a/docs/Introduction.md b/docs/Introduction.md index 00015be..f263408 100644 --- a/docs/Introduction.md +++ b/docs/Introduction.md @@ -38,6 +38,6 @@ Maintainerr supports rules across these apps : - Overseerr - Radarr - Sonarr -- Tautulli (currently available in the dev branch) +- Tautulli :test_tube:{ .dev title="In dev branch only"} :material-clock-edit: Last Updated: 10/10/24 diff --git a/docs/stylesheets/extra.css b/docs/stylesheets/extra.css index 7cf63f9..15dd3b4 100644 --- a/docs/stylesheets/extra.css +++ b/docs/stylesheets/extra.css @@ -8,4 +8,5 @@ } .dev { animation: dev 1500ms infinite; + padding: .5em; } \ No newline at end of file From 201b985a7f75e758f6e2dfa99f69732f688a1bea Mon Sep 17 00:00:00 2001 From: ydkmlt84 Date: Thu, 10 Oct 2024 14:20:57 -0400 Subject: [PATCH 22/41] still workinng on icons --- docs/API.md | 4 ++++ docs/Configuration.md | 4 ++-- docs/Installation.md | 4 ++-- 3 files changed, 8 insertions(+), 4 deletions(-) diff --git a/docs/API.md b/docs/API.md index 9fb7060..d6061ae 100644 --- a/docs/API.md +++ b/docs/API.md @@ -1,3 +1,7 @@ +--- +icon: fontawesome/solid/circle-exclamation +--- + # Maintainerr API Documentation !!! info These docs are currently not auto-generated, are all hand-jammed, and there may be errors. If something doesn't look right, please feel free to raise an [issue](https://github.com/ydkmlt84/Maintainerr_docs/issues) on [Github](https://github.com/ydkmlt84/maintainerr_docs). diff --git a/docs/Configuration.md b/docs/Configuration.md index 984b799..f7cfb9a 100644 --- a/docs/Configuration.md +++ b/docs/Configuration.md @@ -1,4 +1,4 @@ -Test + All configuration is done inside the application, no extra config is required in files.
At first boot you will be redirected to the settings page. @@ -56,7 +56,7 @@ Sonarr's configuration is required to use it's parameters in rules and to remove | Port | The port Sonarr runs on | | Api key | Sonarr API key, should be visible in the Sonarr settings | -## Tautulli (currently only available in the dev branch) +## Tautulli :test_tube:{ .dev title="In dev branch only"} Tautulli's configuration is required to use it's parameters in rules. diff --git a/docs/Installation.md b/docs/Installation.md index df88976..e67fc30 100644 --- a/docs/Installation.md +++ b/docs/Installation.md @@ -56,7 +56,7 @@ The containers data location is set as /opt/data. A docker [volume][tooltip] is 2. For this line, you could also use `jorenn92/maintainerr` instead, to use the DockerHub image. The `latest` tag at the end is not required, unless you want to specify which tag to use. 3. The develop branch could be unstable. -??? note "Development Images" +??? note "Development Versions" - `ghcr.io/jorenn92/maintainerr:main` for the develop branch - `jorenn92/maintainerr:develop` for the Docker Hub development image. @@ -104,7 +104,7 @@ services: 1. For this line, you could also use `jorenn92/maintainerr` instead, to use the DockerHub image. The `latest` tag at the end is not required, unless you want to specify which tag to use. 2. This is defined as `host:container`. -??? note "Development Images" +??? note "Development Versions" - `ghcr.io/jorenn92/maintainerr:main` for the develop branch - `jorenn92/maintainerr:develop` for the Docker Hub development image. From ec628b7161adde874cd2c196a1713c5ec1675159 Mon Sep 17 00:00:00 2001 From: ydkmlt84 Date: Thu, 10 Oct 2024 14:26:14 -0400 Subject: [PATCH 23/41] testing happy status --- docs/API.md | 2 +- docs/Installation.md | 4 ++++ docs/stylesheets/extra.css | 10 +++++++++- mkdocs.yml | 1 + 4 files changed, 15 insertions(+), 2 deletions(-) diff --git a/docs/API.md b/docs/API.md index d6061ae..0d09896 100644 --- a/docs/API.md +++ b/docs/API.md @@ -1,5 +1,5 @@ --- -icon: fontawesome/solid/circle-exclamation +status: new --- # Maintainerr API Documentation diff --git a/docs/Installation.md b/docs/Installation.md index e67fc30..303cd64 100644 --- a/docs/Installation.md +++ b/docs/Installation.md @@ -1,3 +1,7 @@ +--- +status: happy +--- + Docker is Maintainerr's supported method of installation. Images for amd64 & arm64 are available under `jorenn92/maintainerr` and `ghcr.io/jorenn92/maintainerr`. diff --git a/docs/stylesheets/extra.css b/docs/stylesheets/extra.css index 15dd3b4..41ba79c 100644 --- a/docs/stylesheets/extra.css +++ b/docs/stylesheets/extra.css @@ -8,5 +8,13 @@ } .dev { animation: dev 1500ms infinite; - padding: .5em; + padding: .5rem; + } + :root { + --md-status--happy: url('data:image/svg+xml;charset=utf-8,') + } + + .md-status--happy::after { + mask-image: var(--md-status--happy); + -webkit-mask-image: var(--md-status--happy); } \ No newline at end of file diff --git a/mkdocs.yml b/mkdocs.yml index 9dee4c5..b218c89 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -115,6 +115,7 @@ extra: status: new: Recently Added deprecated: Deprecated + happy: New Updates # Extensions markdown_extensions: - abbr From e3a9a0be9652b8fae17f8f923176bdd3640d132e Mon Sep 17 00:00:00 2001 From: ydkmlt84 Date: Thu, 10 Oct 2024 14:36:32 -0400 Subject: [PATCH 24/41] happy icon --- docs/stylesheets/extra.css | 6 +----- 1 file changed, 1 insertion(+), 5 deletions(-) diff --git a/docs/stylesheets/extra.css b/docs/stylesheets/extra.css index 41ba79c..c2c2cd6 100644 --- a/docs/stylesheets/extra.css +++ b/docs/stylesheets/extra.css @@ -9,11 +9,7 @@ .dev { animation: dev 1500ms infinite; padding: .5rem; - } - :root { - --md-status--happy: url('data:image/svg+xml;charset=utf-8,') - } - + } .md-status--happy::after { mask-image: var(--md-status--happy); -webkit-mask-image: var(--md-status--happy); From 42295d84450295210ea0bd542531663257ce38e4 Mon Sep 17 00:00:00 2001 From: ydkmlt84 Date: Thu, 10 Oct 2024 14:45:15 -0400 Subject: [PATCH 25/41] recently updated icon --- docs/Installation.md | 2 +- docs/stylesheets/extra.css | 5 ++--- mkdocs.yml | 2 +- 3 files changed, 4 insertions(+), 5 deletions(-) diff --git a/docs/Installation.md b/docs/Installation.md index 303cd64..96aab5e 100644 --- a/docs/Installation.md +++ b/docs/Installation.md @@ -1,5 +1,5 @@ --- -status: happy +status: recent --- Docker is Maintainerr's supported method of installation. diff --git a/docs/stylesheets/extra.css b/docs/stylesheets/extra.css index c2c2cd6..3b34acc 100644 --- a/docs/stylesheets/extra.css +++ b/docs/stylesheets/extra.css @@ -10,7 +10,6 @@ animation: dev 1500ms infinite; padding: .5rem; } - .md-status--happy::after { - mask-image: var(--md-status--happy); - -webkit-mask-image: var(--md-status--happy); + .md-status--recent::after { + mask-image: url('data:image/svg+xml;charset=utf-8,new-box'); } \ No newline at end of file diff --git a/mkdocs.yml b/mkdocs.yml index b218c89..45000aa 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -115,7 +115,7 @@ extra: status: new: Recently Added deprecated: Deprecated - happy: New Updates + recent: New Updates # Extensions markdown_extensions: - abbr From 03d77d735502a2c0cd1adf51c0dc1d0924f9b4ca Mon Sep 17 00:00:00 2001 From: ydkmlt84 Date: Thu, 10 Oct 2024 14:55:03 -0400 Subject: [PATCH 26/41] plus icon --- docs/stylesheets/extra.css | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/stylesheets/extra.css b/docs/stylesheets/extra.css index 3b34acc..1313191 100644 --- a/docs/stylesheets/extra.css +++ b/docs/stylesheets/extra.css @@ -11,5 +11,5 @@ padding: .5rem; } .md-status--recent::after { - mask-image: url('data:image/svg+xml;charset=utf-8,new-box'); + mask-image: url('data:image/svg+xml;charset=utf-8,plus-circle'); } \ No newline at end of file From d94618fb6462924395640d993b2b0ff2718c28d3 Mon Sep 17 00:00:00 2001 From: ydkmlt84 Date: Thu, 10 Oct 2024 14:56:58 -0400 Subject: [PATCH 27/41] Update extra.css remove padding --- docs/stylesheets/extra.css | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/docs/stylesheets/extra.css b/docs/stylesheets/extra.css index 1313191..f68a054 100644 --- a/docs/stylesheets/extra.css +++ b/docs/stylesheets/extra.css @@ -8,8 +8,7 @@ } .dev { animation: dev 1500ms infinite; - padding: .5rem; } .md-status--recent::after { mask-image: url('data:image/svg+xml;charset=utf-8,plus-circle'); - } \ No newline at end of file + } From f8e5060fe5cf0c4f9d4c7cb868220ad293d554a5 Mon Sep 17 00:00:00 2001 From: ydkmlt84 Date: Thu, 10 Oct 2024 15:03:52 -0400 Subject: [PATCH 28/41] removed api for now --- docs/API.md | 15 --------------- mkdocs.yml | 2 -- 2 files changed, 17 deletions(-) delete mode 100644 docs/API.md diff --git a/docs/API.md b/docs/API.md deleted file mode 100644 index 0d09896..0000000 --- a/docs/API.md +++ /dev/null @@ -1,15 +0,0 @@ ---- -status: new ---- - -# Maintainerr API Documentation -!!! info - These docs are currently not auto-generated, are all hand-jammed, and there may be errors. If something doesn't look right, please feel free to raise an [issue](https://github.com/ydkmlt84/Maintainerr_docs/issues) on [Github](https://github.com/ydkmlt84/maintainerr_docs). - -## Public endpoints - -!!! note "" - == GET == - - -:material-clock-edit: Last Updated: 10/10/24 diff --git a/mkdocs.yml b/mkdocs.yml index 45000aa..0508955 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -188,8 +188,6 @@ nav: - Community: - Introduction.md - Contributing.md - - API: - - API.md - Guides: - blog/index.md From a70fe80cfa7a5c7631df79932cec991284d386db Mon Sep 17 00:00:00 2001 From: ydkmlt84 Date: Thu, 10 Oct 2024 15:25:02 -0400 Subject: [PATCH 29/41] update workflow to test for branch --- .github/workflows/ci.yml | 24 ++++++++++++++++++- .github/workflows/ci_dev.yml | 45 ------------------------------------ 2 files changed, 23 insertions(+), 46 deletions(-) delete mode 100644 .github/workflows/ci_dev.yml diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index d8f41e6..7a37fc2 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -4,6 +4,7 @@ on: push: branches: - 'main' + - 'develop' release: type: [published] pull_request: @@ -23,6 +24,7 @@ jobs: if: ${{ github.triggering_actor == github.repository_owner }} name: Use tailscale to connect and execute command. runs-on: ubuntu-24.04 + if: github.ref == 'refs/head/main' steps: - name: Tailscale uses: tailscale/github-action@v2 @@ -49,5 +51,25 @@ jobs: DISCORD_WEBHOOK: ${{ secrets.DISCORD_WEBHOOK }} with: args: 'The docs have been updated. Take a look. https://docs.maintainerr.info' - + if: github.ref == 'refs/head/develop' + steps: + - name: Tailscale + uses: tailscale/github-action@v2 + with: + oauth-client-id: ${{ secrets.TS_OAUTH_CLIENT_ID }} + oauth-secret: ${{ secrets.TS_OAUTH_SECRET }} + tags: tag:ci + - name: getting boolean status + run: echo ${{inputs.dry-run}} + shell: bash + - name: executing remote ssh commands using password + if: ${{ inputs.dry-run == false }} + uses: appleboy/ssh-action@v1.0.3 + with: + host: ${{ secrets.SSH_HOST_TS }} + username: ${{ secrets.SSH_USERNAME }} + password: ${{ secrets.SSH_PASSWORD }} + port: ${{ secrets.SSH_PORT }} + script_stop: true + script: /bin/sh /home/thatoneguy99/.docker/mkdocs/action_execute_dev.sh diff --git a/.github/workflows/ci_dev.yml b/.github/workflows/ci_dev.yml deleted file mode 100644 index 15422e2..0000000 --- a/.github/workflows/ci_dev.yml +++ /dev/null @@ -1,45 +0,0 @@ -name: pushed_updates_dev -run-name: ${{ github.actor }} Update dev docs after changes are pushed. -on: - push: - branches: - - 'develop' - pull_request: - types: - - 'closed' - branches: - - 'develop' - workflow_dispatch: - inputs: - dry-run: - type: boolean - description: Turn this on to skip running the SSH script. - default: false - -jobs: - execute-command: - if: ${{ github.triggering_actor == github.repository_owner }} - name: Use tailscale to connect and execute command. - runs-on: ubuntu-24.04 - steps: - - name: Tailscale - uses: tailscale/github-action@v2 - with: - oauth-client-id: ${{ secrets.TS_OAUTH_CLIENT_ID }} - oauth-secret: ${{ secrets.TS_OAUTH_SECRET }} - tags: tag:ci - - name: showing dry-run input - run: echo ${{inputs.dry-run}} - shell: bash - - name: executing remote ssh commands using password - if: ${{ inputs.dry-run == false }} - uses: appleboy/ssh-action@v1.0.3 - with: - host: ${{ secrets.SSH_HOST_TS }} - username: ${{ secrets.SSH_USERNAME }} - password: ${{ secrets.SSH_PASSWORD }} - port: ${{ secrets.SSH_PORT }} - script_stop: true - script: /bin/sh /home/thatoneguy99/.docker/mkdocs/action_execute_dev.sh - - \ No newline at end of file From 932d29ab0fb7b53e8ab609d8a9e42da78f4545ab Mon Sep 17 00:00:00 2001 From: ydkmlt84 Date: Thu, 10 Oct 2024 15:28:02 -0400 Subject: [PATCH 30/41] workflow --- .github/workflows/ci.yml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index 7a37fc2..4b0aa16 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -24,7 +24,7 @@ jobs: if: ${{ github.triggering_actor == github.repository_owner }} name: Use tailscale to connect and execute command. runs-on: ubuntu-24.04 - if: github.ref == 'refs/head/main' + if: ${{ github.ref == 'refs/head/main' }} steps: - name: Tailscale uses: tailscale/github-action@v2 @@ -51,7 +51,7 @@ jobs: DISCORD_WEBHOOK: ${{ secrets.DISCORD_WEBHOOK }} with: args: 'The docs have been updated. Take a look. https://docs.maintainerr.info' - if: github.ref == 'refs/head/develop' + if: ${{ github.ref == 'refs/head/develop' }} steps: - name: Tailscale uses: tailscale/github-action@v2 From b585c02e36e507f2f8f4774972a75c86f0802e99 Mon Sep 17 00:00:00 2001 From: ydkmlt84 Date: Thu, 10 Oct 2024 15:33:30 -0400 Subject: [PATCH 31/41] workflow2 --- .github/workflows/ci.yml | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index 4b0aa16..f67f21c 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -22,9 +22,9 @@ on: jobs: execute-command: if: ${{ github.triggering_actor == github.repository_owner }} - name: Use tailscale to connect and execute command. - runs-on: ubuntu-24.04 if: ${{ github.ref == 'refs/head/main' }} + name: Use tailscale to connect and execute command. + runs-on: ubuntu-24.04 steps: - name: Tailscale uses: tailscale/github-action@v2 @@ -52,6 +52,8 @@ jobs: with: args: 'The docs have been updated. Take a look. https://docs.maintainerr.info' if: ${{ github.ref == 'refs/head/develop' }} + name: Dev-Use tailscale to connect and execute command. + runs-on: ubuntu-24.04 steps: - name: Tailscale uses: tailscale/github-action@v2 From e35969ac3c3fbce0a8230fd9c66719c463886e9a Mon Sep 17 00:00:00 2001 From: ydkmlt84 Date: Thu, 10 Oct 2024 15:34:37 -0400 Subject: [PATCH 32/41] workflow3 --- .github/workflows/ci.yml | 1 - 1 file changed, 1 deletion(-) diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index f67f21c..8f891eb 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -21,7 +21,6 @@ on: jobs: execute-command: - if: ${{ github.triggering_actor == github.repository_owner }} if: ${{ github.ref == 'refs/head/main' }} name: Use tailscale to connect and execute command. runs-on: ubuntu-24.04 From aaf7f9486a40435e3644328c2e001f0568925f52 Mon Sep 17 00:00:00 2001 From: ydkmlt84 Date: Thu, 10 Oct 2024 15:41:12 -0400 Subject: [PATCH 33/41] workflow 4 --- .github/workflows/ci.yml | 100 +++++++++++++++++++-------------------- 1 file changed, 49 insertions(+), 51 deletions(-) diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index 8f891eb..46bab92 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -21,56 +21,54 @@ on: jobs: execute-command: - if: ${{ github.ref == 'refs/head/main' }} name: Use tailscale to connect and execute command. - runs-on: ubuntu-24.04 - steps: - - name: Tailscale - uses: tailscale/github-action@v2 - with: - oauth-client-id: ${{ secrets.TS_OAUTH_CLIENT_ID }} - oauth-secret: ${{ secrets.TS_OAUTH_SECRET }} - tags: tag:ci - - name: getting boolean status - run: echo ${{inputs.dry-run}} - shell: bash - - name: executing remote ssh commands using password - if: ${{ inputs.dry-run == false }} - uses: appleboy/ssh-action@v1.0.3 - with: - host: ${{ secrets.SSH_HOST_TS }} - username: ${{ secrets.SSH_USERNAME }} - password: ${{ secrets.SSH_PASSWORD }} - port: ${{ secrets.SSH_PORT }} - script_stop: true - script: /bin/sh /home/thatoneguy99/.docker/mkdocs/action_execute.sh - - name: Actions for Discord - uses: Ilshidur/action-discord@0.3.2 - env: - DISCORD_WEBHOOK: ${{ secrets.DISCORD_WEBHOOK }} - with: - args: 'The docs have been updated. Take a look. https://docs.maintainerr.info' - if: ${{ github.ref == 'refs/head/develop' }} - name: Dev-Use tailscale to connect and execute command. - runs-on: ubuntu-24.04 - steps: - - name: Tailscale - uses: tailscale/github-action@v2 - with: - oauth-client-id: ${{ secrets.TS_OAUTH_CLIENT_ID }} - oauth-secret: ${{ secrets.TS_OAUTH_SECRET }} - tags: tag:ci - - name: getting boolean status - run: echo ${{inputs.dry-run}} - shell: bash - - name: executing remote ssh commands using password - if: ${{ inputs.dry-run == false }} - uses: appleboy/ssh-action@v1.0.3 - with: - host: ${{ secrets.SSH_HOST_TS }} - username: ${{ secrets.SSH_USERNAME }} - password: ${{ secrets.SSH_PASSWORD }} - port: ${{ secrets.SSH_PORT }} - script_stop: true - script: /bin/sh /home/thatoneguy99/.docker/mkdocs/action_execute_dev.sh + runs-on: ubuntu-24.04 + if: ${{ github.ref_name == 'main' }} + steps: + - name: Tailscale + uses: tailscale/github-action@v2 + with: + oauth-client-id: ${{ secrets.TS_OAUTH_CLIENT_ID }} + oauth-secret: ${{ secrets.TS_OAUTH_SECRET }} + tags: tag:ci + - name: getting boolean status + run: echo ${{inputs.dry-run}} + shell: bash + - name: executing remote ssh commands using password + if: ${{ inputs.dry-run == false }} + uses: appleboy/ssh-action@v1.0.3 + with: + host: ${{ secrets.SSH_HOST_TS }} + username: ${{ secrets.SSH_USERNAME }} + password: ${{ secrets.SSH_PASSWORD }} + port: ${{ secrets.SSH_PORT }} + script_stop: true + script: /bin/sh /home/thatoneguy99/.docker/mkdocs/action_execute.sh + - name: Actions for Discord + uses: Ilshidur/action-discord@0.3.2 + env: + DISCORD_WEBHOOK: ${{ secrets.DISCORD_WEBHOOK }} + with: + args: 'The docs have been updated. Take a look. https://docs.maintainerr.info' + if: ${{ github.ref_name == 'develop' }} + steps: + - name: Tailscale + uses: tailscale/github-action@v2 + with: + oauth-client-id: ${{ secrets.TS_OAUTH_CLIENT_ID }} + oauth-secret: ${{ secrets.TS_OAUTH_SECRET }} + tags: tag:ci + - name: getting boolean status + run: echo ${{inputs.dry-run}} + shell: bash + - name: executing remote ssh commands using password + if: ${{ inputs.dry-run == false }} + uses: appleboy/ssh-action@v1.0.3 + with: + host: ${{ secrets.SSH_HOST_TS }} + username: ${{ secrets.SSH_USERNAME }} + password: ${{ secrets.SSH_PASSWORD }} + port: ${{ secrets.SSH_PORT }} + script_stop: true + script: /bin/sh /home/thatoneguy99/.docker/mkdocs/action_execute_dev.sh From 7520376d02cf92d32d2fff06c1732b07ce456731 Mon Sep 17 00:00:00 2001 From: ydkmlt84 Date: Thu, 10 Oct 2024 15:43:02 -0400 Subject: [PATCH 34/41] workflow 5 --- .github/workflows/ci.yml | 92 ++++++++++++++++++++-------------------- 1 file changed, 46 insertions(+), 46 deletions(-) diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index 46bab92..d913a47 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -24,51 +24,51 @@ jobs: name: Use tailscale to connect and execute command. runs-on: ubuntu-24.04 if: ${{ github.ref_name == 'main' }} - steps: - - name: Tailscale - uses: tailscale/github-action@v2 - with: - oauth-client-id: ${{ secrets.TS_OAUTH_CLIENT_ID }} - oauth-secret: ${{ secrets.TS_OAUTH_SECRET }} - tags: tag:ci - - name: getting boolean status - run: echo ${{inputs.dry-run}} - shell: bash - - name: executing remote ssh commands using password - if: ${{ inputs.dry-run == false }} - uses: appleboy/ssh-action@v1.0.3 - with: - host: ${{ secrets.SSH_HOST_TS }} - username: ${{ secrets.SSH_USERNAME }} - password: ${{ secrets.SSH_PASSWORD }} - port: ${{ secrets.SSH_PORT }} - script_stop: true - script: /bin/sh /home/thatoneguy99/.docker/mkdocs/action_execute.sh - - name: Actions for Discord - uses: Ilshidur/action-discord@0.3.2 - env: - DISCORD_WEBHOOK: ${{ secrets.DISCORD_WEBHOOK }} - with: - args: 'The docs have been updated. Take a look. https://docs.maintainerr.info' + steps: + - name: Tailscale + uses: tailscale/github-action@v2 + with: + oauth-client-id: ${{ secrets.TS_OAUTH_CLIENT_ID }} + oauth-secret: ${{ secrets.TS_OAUTH_SECRET }} + tags: tag:ci + - name: getting boolean status + run: echo ${{inputs.dry-run}} + shell: bash + - name: executing remote ssh commands using password + if: ${{ inputs.dry-run == false }} + uses: appleboy/ssh-action@v1.0.3 + with: + host: ${{ secrets.SSH_HOST_TS }} + username: ${{ secrets.SSH_USERNAME }} + password: ${{ secrets.SSH_PASSWORD }} + port: ${{ secrets.SSH_PORT }} + script_stop: true + script: /bin/sh /home/thatoneguy99/.docker/mkdocs/action_execute.sh + - name: Actions for Discord + uses: Ilshidur/action-discord@0.3.2 + env: + DISCORD_WEBHOOK: ${{ secrets.DISCORD_WEBHOOK }} + with: + args: 'The docs have been updated. Take a look. https://docs.maintainerr.info' if: ${{ github.ref_name == 'develop' }} - steps: - - name: Tailscale - uses: tailscale/github-action@v2 - with: - oauth-client-id: ${{ secrets.TS_OAUTH_CLIENT_ID }} - oauth-secret: ${{ secrets.TS_OAUTH_SECRET }} - tags: tag:ci - - name: getting boolean status - run: echo ${{inputs.dry-run}} - shell: bash - - name: executing remote ssh commands using password - if: ${{ inputs.dry-run == false }} - uses: appleboy/ssh-action@v1.0.3 - with: - host: ${{ secrets.SSH_HOST_TS }} - username: ${{ secrets.SSH_USERNAME }} - password: ${{ secrets.SSH_PASSWORD }} - port: ${{ secrets.SSH_PORT }} - script_stop: true - script: /bin/sh /home/thatoneguy99/.docker/mkdocs/action_execute_dev.sh + steps: + - name: Tailscale + uses: tailscale/github-action@v2 + with: + oauth-client-id: ${{ secrets.TS_OAUTH_CLIENT_ID }} + oauth-secret: ${{ secrets.TS_OAUTH_SECRET }} + tags: tag:ci + - name: getting boolean status + run: echo ${{inputs.dry-run}} + shell: bash + - name: executing remote ssh commands using password + if: ${{ inputs.dry-run == false }} + uses: appleboy/ssh-action@v1.0.3 + with: + host: ${{ secrets.SSH_HOST_TS }} + username: ${{ secrets.SSH_USERNAME }} + password: ${{ secrets.SSH_PASSWORD }} + port: ${{ secrets.SSH_PORT }} + script_stop: true + script: /bin/sh /home/thatoneguy99/.docker/mkdocs/action_execute_dev.sh From d55164a19e856223a590a9f15b7eb3f88feacd32 Mon Sep 17 00:00:00 2001 From: ydkmlt84 Date: Thu, 10 Oct 2024 17:00:04 -0400 Subject: [PATCH 35/41] workflow 6 --- .github/workflows/ci.yml | 26 ++------------------------ 1 file changed, 2 insertions(+), 24 deletions(-) diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index d913a47..e13506c 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -21,9 +21,9 @@ on: jobs: execute-command: + if: ${{ github.ref_name == 'main' }} name: Use tailscale to connect and execute command. runs-on: ubuntu-24.04 - if: ${{ github.ref_name == 'main' }} steps: - name: Tailscale uses: tailscale/github-action@v2 @@ -49,26 +49,4 @@ jobs: env: DISCORD_WEBHOOK: ${{ secrets.DISCORD_WEBHOOK }} with: - args: 'The docs have been updated. Take a look. https://docs.maintainerr.info' - if: ${{ github.ref_name == 'develop' }} - steps: - - name: Tailscale - uses: tailscale/github-action@v2 - with: - oauth-client-id: ${{ secrets.TS_OAUTH_CLIENT_ID }} - oauth-secret: ${{ secrets.TS_OAUTH_SECRET }} - tags: tag:ci - - name: getting boolean status - run: echo ${{inputs.dry-run}} - shell: bash - - name: executing remote ssh commands using password - if: ${{ inputs.dry-run == false }} - uses: appleboy/ssh-action@v1.0.3 - with: - host: ${{ secrets.SSH_HOST_TS }} - username: ${{ secrets.SSH_USERNAME }} - password: ${{ secrets.SSH_PASSWORD }} - port: ${{ secrets.SSH_PORT }} - script_stop: true - script: /bin/sh /home/thatoneguy99/.docker/mkdocs/action_execute_dev.sh - + args: 'The docs have been updated. Take a look. https://docs.maintainerr.info' \ No newline at end of file From b5f52aca4e6674ca8ef50aa59a25c957ddc43e9a Mon Sep 17 00:00:00 2001 From: ydkmlt84 Date: Thu, 10 Oct 2024 17:22:59 -0400 Subject: [PATCH 36/41] workflow 7 --- .github/workflows/ci.yml | 25 ++++++++++++++++++++++++- 1 file changed, 24 insertions(+), 1 deletion(-) diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index e13506c..58d9107 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -49,4 +49,27 @@ jobs: env: DISCORD_WEBHOOK: ${{ secrets.DISCORD_WEBHOOK }} with: - args: 'The docs have been updated. Take a look. https://docs.maintainerr.info' \ No newline at end of file + args: 'The docs have been updated. Take a look. https://docs.maintainerr.info' + if: ${{ github.ref_name == 'develop' }} + name: Dev-use tailscale to connect and run command. +runs-on: ubuntu-24.04 + steps: + - name: Tailscale + uses: tailscale/github-action@v2 + with: + oauth-client-id: ${{ secrets.TS_OAUTH_CLIENT_ID }} + oauth-secret: ${{ secrets.TS_OAUTH_SECRET }} + tags: tag:ci + - name: getting boolean status + run: echo ${{inputs.dry-run}} + shell: bash + - name: executing remote ssh commands using password + if: ${{ inputs.dry-run == false }} + uses: appleboy/ssh-action@v1.0.3 + with: + host: ${{ secrets.SSH_HOST_TS }} + username: ${{ secrets.SSH_USERNAME }} + password: ${{ secrets.SSH_PASSWORD }} + port: ${{ secrets.SSH_PORT }} + script_stop: true + script: /bin/sh /home/thatoneguy99/.docker/mkdocs/action_execute_dev.sh From f05fa2a86c5f45c7fe665c20c9f2b10035c6f84c Mon Sep 17 00:00:00 2001 From: ydkmlt84 Date: Thu, 10 Oct 2024 17:32:25 -0400 Subject: [PATCH 37/41] workflow 8 --- .github/workflows/ci.yml | 29 ++++------------------------- 1 file changed, 4 insertions(+), 25 deletions(-) diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index 58d9107..dc873a0 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -21,7 +21,6 @@ on: jobs: execute-command: - if: ${{ github.ref_name == 'main' }} name: Use tailscale to connect and execute command. runs-on: ubuntu-24.04 steps: @@ -43,33 +42,13 @@ jobs: password: ${{ secrets.SSH_PASSWORD }} port: ${{ secrets.SSH_PORT }} script_stop: true + if: ${{ github.ref_name == 'main' }} script: /bin/sh /home/thatoneguy99/.docker/mkdocs/action_execute.sh + if: ${{ github.ref_name == 'develop' }} + script: /bin/sh /home/thatoneguy99/.docker/mkdocs/action_execute_dev.sh - name: Actions for Discord uses: Ilshidur/action-discord@0.3.2 env: DISCORD_WEBHOOK: ${{ secrets.DISCORD_WEBHOOK }} with: - args: 'The docs have been updated. Take a look. https://docs.maintainerr.info' - if: ${{ github.ref_name == 'develop' }} - name: Dev-use tailscale to connect and run command. -runs-on: ubuntu-24.04 - steps: - - name: Tailscale - uses: tailscale/github-action@v2 - with: - oauth-client-id: ${{ secrets.TS_OAUTH_CLIENT_ID }} - oauth-secret: ${{ secrets.TS_OAUTH_SECRET }} - tags: tag:ci - - name: getting boolean status - run: echo ${{inputs.dry-run}} - shell: bash - - name: executing remote ssh commands using password - if: ${{ inputs.dry-run == false }} - uses: appleboy/ssh-action@v1.0.3 - with: - host: ${{ secrets.SSH_HOST_TS }} - username: ${{ secrets.SSH_USERNAME }} - password: ${{ secrets.SSH_PASSWORD }} - port: ${{ secrets.SSH_PORT }} - script_stop: true - script: /bin/sh /home/thatoneguy99/.docker/mkdocs/action_execute_dev.sh + args: 'The docs have been updated. Take a look. https://docs.maintainerr.info' \ No newline at end of file From 888ef7023a3fe9f1ec159b394244872ab6e541d8 Mon Sep 17 00:00:00 2001 From: ydkmlt84 Date: Thu, 10 Oct 2024 19:52:22 -0400 Subject: [PATCH 38/41] workflow 15 --- .github/workflows/ci.yml | 28 ++++++++++++++++++++++++---- 1 file changed, 24 insertions(+), 4 deletions(-) diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index dc873a0..e8ad5d1 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -23,6 +23,7 @@ jobs: execute-command: name: Use tailscale to connect and execute command. runs-on: ubuntu-24.04 + if: ${{ github.ref_name == 'main' }} steps: - name: Tailscale uses: tailscale/github-action@v2 @@ -42,13 +43,32 @@ jobs: password: ${{ secrets.SSH_PASSWORD }} port: ${{ secrets.SSH_PORT }} script_stop: true - if: ${{ github.ref_name == 'main' }} script: /bin/sh /home/thatoneguy99/.docker/mkdocs/action_execute.sh - if: ${{ github.ref_name == 'develop' }} - script: /bin/sh /home/thatoneguy99/.docker/mkdocs/action_execute_dev.sh - name: Actions for Discord uses: Ilshidur/action-discord@0.3.2 env: DISCORD_WEBHOOK: ${{ secrets.DISCORD_WEBHOOK }} with: - args: 'The docs have been updated. Take a look. https://docs.maintainerr.info' \ No newline at end of file + args: 'The docs have been updated. Take a look. https://docs.maintainerr.info' + if: ${{ github.ref_name == 'develop' }} + steps: + - name: Tailscale + uses: tailscale/github-action@v2 + with: + oauth-client-id: ${{ secrets.TS_OAUTH_CLIENT_ID }} + oauth-secret: ${{ secrets.TS_OAUTH_SECRET }} + tags: tag:ci + - name: getting boolean status + run: echo ${{inputs.dry-run}} + shell: bash + - name: executing remote ssh commands using password + if: ${{ inputs.dry-run == false }} + uses: appleboy/ssh-action@v1.0.3 + with: + host: ${{ secrets.SSH_HOST_TS }} + username: ${{ secrets.SSH_USERNAME }} + password: ${{ secrets.SSH_PASSWORD }} + port: ${{ secrets.SSH_PORT }} + script_stop: true + script: /bin/sh /home/thatoneguy99/.docker/mkdocs/action_execute_dev.sh + \ No newline at end of file From ab22d3c1048560c69e7f752b24c44da381c7919c Mon Sep 17 00:00:00 2001 From: ydkmlt84 Date: Thu, 10 Oct 2024 19:54:24 -0400 Subject: [PATCH 39/41] workflow 47 --- .github/workflows/ci.yml | 10 ++++++---- 1 file changed, 6 insertions(+), 4 deletions(-) diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index e8ad5d1..2dc23a5 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -20,10 +20,10 @@ on: default: false jobs: + if: ${{ github.ref_name == 'main' }} execute-command: name: Use tailscale to connect and execute command. runs-on: ubuntu-24.04 - if: ${{ github.ref_name == 'main' }} steps: - name: Tailscale uses: tailscale/github-action@v2 @@ -50,7 +50,10 @@ jobs: DISCORD_WEBHOOK: ${{ secrets.DISCORD_WEBHOOK }} with: args: 'The docs have been updated. Take a look. https://docs.maintainerr.info' - if: ${{ github.ref_name == 'develop' }} + if: ${{ github.ref_name == 'develop' }} + execute-command: + name: Use tailscale to connect and execute command. + runs-on: ubuntu-24.04 steps: - name: Tailscale uses: tailscale/github-action@v2 @@ -70,5 +73,4 @@ jobs: password: ${{ secrets.SSH_PASSWORD }} port: ${{ secrets.SSH_PORT }} script_stop: true - script: /bin/sh /home/thatoneguy99/.docker/mkdocs/action_execute_dev.sh - \ No newline at end of file + script: /bin/sh /home/thatoneguy99/.docker/mkdocs/action_execute_dev.sh \ No newline at end of file From 2d83d00238aa88390403e15f4345a48ef814ce1a Mon Sep 17 00:00:00 2001 From: ydkmlt84 Date: Thu, 10 Oct 2024 20:04:58 -0400 Subject: [PATCH 40/41] workflow 82 --- .github/workflows/ci.yml | 37 +++++++++++-------------------------- 1 file changed, 11 insertions(+), 26 deletions(-) diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index 2dc23a5..d87ac3a 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -19,8 +19,7 @@ on: description: Turn this on to skip running the SSH script. default: false -jobs: - if: ${{ github.ref_name == 'main' }} +jobs: execute-command: name: Use tailscale to connect and execute command. runs-on: ubuntu-24.04 @@ -35,7 +34,7 @@ jobs: run: echo ${{inputs.dry-run}} shell: bash - name: executing remote ssh commands using password - if: ${{ inputs.dry-run == false }} + if: ${{ inputs.dry-run == false && github.ref_name == 'main'}} uses: appleboy/ssh-action@v1.0.3 with: host: ${{ secrets.SSH_HOST_TS }} @@ -44,28 +43,8 @@ jobs: port: ${{ secrets.SSH_PORT }} script_stop: true script: /bin/sh /home/thatoneguy99/.docker/mkdocs/action_execute.sh - - name: Actions for Discord - uses: Ilshidur/action-discord@0.3.2 - env: - DISCORD_WEBHOOK: ${{ secrets.DISCORD_WEBHOOK }} - with: - args: 'The docs have been updated. Take a look. https://docs.maintainerr.info' - if: ${{ github.ref_name == 'develop' }} - execute-command: - name: Use tailscale to connect and execute command. - runs-on: ubuntu-24.04 - steps: - - name: Tailscale - uses: tailscale/github-action@v2 - with: - oauth-client-id: ${{ secrets.TS_OAUTH_CLIENT_ID }} - oauth-secret: ${{ secrets.TS_OAUTH_SECRET }} - tags: tag:ci - - name: getting boolean status - run: echo ${{inputs.dry-run}} - shell: bash - - name: executing remote ssh commands using password - if: ${{ inputs.dry-run == false }} + - name: Dev- executing remote ssh commands using password + if: ${{ inputs.dry-run == false && github.ref_name == 'develop'}} uses: appleboy/ssh-action@v1.0.3 with: host: ${{ secrets.SSH_HOST_TS }} @@ -73,4 +52,10 @@ jobs: password: ${{ secrets.SSH_PASSWORD }} port: ${{ secrets.SSH_PORT }} script_stop: true - script: /bin/sh /home/thatoneguy99/.docker/mkdocs/action_execute_dev.sh \ No newline at end of file + script: /bin/sh /home/thatoneguy99/.docker/mkdocs/action_execute_dev.sh + - name: Actions for Discord + uses: Ilshidur/action-discord@0.3.2 + env: + DISCORD_WEBHOOK: ${{ secrets.DISCORD_WEBHOOK }} + with: + args: 'The docs have been updated. Take a look. https://docs.maintainerr.info' \ No newline at end of file From 176726e16e943ea96ea5d61e46677dd381782f69 Mon Sep 17 00:00:00 2001 From: ydkmlt84 Date: Thu, 10 Oct 2024 20:06:47 -0400 Subject: [PATCH 41/41] discord notification only for main branch --- .github/workflows/ci.yml | 1 + 1 file changed, 1 insertion(+) diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index d87ac3a..356bd26 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -54,6 +54,7 @@ jobs: script_stop: true script: /bin/sh /home/thatoneguy99/.docker/mkdocs/action_execute_dev.sh - name: Actions for Discord + if: ${{ github.ref_name == 'main'}} uses: Ilshidur/action-discord@0.3.2 env: DISCORD_WEBHOOK: ${{ secrets.DISCORD_WEBHOOK }}