open-source-guides
/
TRaSH-Guides
mirror of https://github.com/TRaSH-/Guides
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
Branches Tags
${ item.name }
Create tag ${ searchTerm }
Create branch ${ searchTerm }
from '90bec1cd2b'
${ noResults }
TRaSH-Guides/metadata.json

13 lines
255 B
Raw Normal View History Unescape

chore: New metadata.json file with repo information Currently, tooling that references files in the Trash Guides github repository has no reliable way to know where certain information lives. For example, the Recyclarr application hard-codes paths (relative to the repo root) to find the location of certain JSON files for Sonarr and Radarr. Hard-coding paths is a poor practice because it limits the ability for the Guides repository to be reorganized without breaking tools. This commit introduces a file named `metadata.json` that exists at the root of the repository. Its sole purpose is to communicate information about the repository itself. For now, the only thing this file provides is the paths to JSON files for Radarr custom formats and Sonarr release profiles. This file will never move, otherwise we run into the same issue that existed prior to having this file. When relevant files or directories are reorganized in the repository, respective paths in `metadata.json` will be updated which will allow tooling to continue to find needed resources. The catalyst for this change is that there has been discussion recently about a new structure for JSON files in the repository due to the introduction of Sonarr v4 JSON files. Lastly, a schema has been provided to assist with live editing in `metadata.json`. The schema file is named `metadata.schema.json`. Some editors provide validation as you edit JSON files (e.g. VS Code), which will take advantage of this Fixes #703
2 years ago
{
"$schema": "metadata.schema.json",
"json_paths": {
"radarr": {
Fix: Screw after Screw Up - Fix: Screw after Screw Up
2 years ago
"custom_formats": ["docs/json/radarr/cf"]
chore: New metadata.json file with repo information Currently, tooling that references files in the Trash Guides github repository has no reliable way to know where certain information lives. For example, the Recyclarr application hard-codes paths (relative to the repo root) to find the location of certain JSON files for Sonarr and Radarr. Hard-coding paths is a poor practice because it limits the ability for the Guides repository to be reorganized without breaking tools. This commit introduces a file named `metadata.json` that exists at the root of the repository. Its sole purpose is to communicate information about the repository itself. For now, the only thing this file provides is the paths to JSON files for Radarr custom formats and Sonarr release profiles. This file will never move, otherwise we run into the same issue that existed prior to having this file. When relevant files or directories are reorganized in the repository, respective paths in `metadata.json` will be updated which will allow tooling to continue to find needed resources. The catalyst for this change is that there has been discussion recently about a new structure for JSON files in the repository due to the introduction of Sonarr v4 JSON files. Lastly, a schema has been provided to assist with live editing in `metadata.json`. The schema file is named `metadata.schema.json`. Some editors provide validation as you edit JSON files (e.g. VS Code), which will take advantage of this Fixes #703
2 years ago
},
"sonarr": {
Update metadata.json
2 years ago
"release_profiles": ["docs/json/sonarr/rp"],
"custom_formats": ["docs/json/sonarr/cf"]
chore: New metadata.json file with repo information Currently, tooling that references files in the Trash Guides github repository has no reliable way to know where certain information lives. For example, the Recyclarr application hard-codes paths (relative to the repo root) to find the location of certain JSON files for Sonarr and Radarr. Hard-coding paths is a poor practice because it limits the ability for the Guides repository to be reorganized without breaking tools. This commit introduces a file named `metadata.json` that exists at the root of the repository. Its sole purpose is to communicate information about the repository itself. For now, the only thing this file provides is the paths to JSON files for Radarr custom formats and Sonarr release profiles. This file will never move, otherwise we run into the same issue that existed prior to having this file. When relevant files or directories are reorganized in the repository, respective paths in `metadata.json` will be updated which will allow tooling to continue to find needed resources. The catalyst for this change is that there has been discussion recently about a new structure for JSON files in the repository due to the introduction of Sonarr v4 JSON files. Lastly, a schema has been provided to assist with live editing in `metadata.json`. The schema file is named `metadata.schema.json`. Some editors provide validation as you edit JSON files (e.g. VS Code), which will take advantage of this Fixes #703
2 years ago
}
}
}