Config overhaul: use an explicit section for metadata #991
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
The metadata section in the configuration file is changed:
TOML:
```toml
[metadata]
app = "torrust-tracker"
purpose = "configuration"
schema_version = "2.0.0"
```
JSON:
```json
{
"metadata": {
"app": "torrust-tracker",
"purpose": "configuration",
"version": "2.0.0"
}
}
```
- `app`: the applications this config file is used for.
- `purpose`: the purpose of the file containing these metadata.
- `schema_version`: the schema version for the file being parsed.
josecelano
force-pushed
the
958-config-overhaul-use-an-explicit-section-for-metadata
branch
from
ba0f455
to
287e484
Compare
|
ACK 287e484 |
Codecov ReportAttention: Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## develop #991 +/- ##
===========================================
+ Coverage 77.11% 77.13% +0.01%
===========================================
Files 185 185
Lines 10025 10036 +11
===========================================
+ Hits 7731 7741 +10
- Misses 2294 2295 +1 ☔ View full report in Codecov by Sentry. |
josecelano
deleted the
958-config-overhaul-use-an-explicit-section-for-metadata
branch
This was referenced Aug 5, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
The metadata section in the configuration file is changed:
TOML:
JSON:
{ "metadata": { "app": "torrust-tracker", "purpose": "configuration", "version": "2.0.0" } }app: the application this config file is used for.purpose: the purpose of the file containing these metadata.schema_version: the schema version for the file being parsed.