Skip to content

Commit

Permalink
Smaller fixes to JSON specification
Browse files Browse the repository at this point in the history
  • Loading branch information
olehermanse committed Oct 28, 2021
1 parent a872399 commit 5ea509e
Showing 1 changed file with 3 additions and 4 deletions.
7 changes: 3 additions & 4 deletions JSON.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ The CFEngine Build website and tooling relies on JSON files for different purpos

- The project file (`cfbs.json`) generated by running `cfbs init` when you start a new project
- The index of all available modules which is available on GitHub
- A cfbs.json file with necessary metadata for adding a module using URL (not from index)
- A `cfbs.json` file with necessary metadata for adding a module using URL (not from index)

All these 3 share 1 standard format, commonly called `cfbs.json`.

Expand All @@ -14,7 +14,7 @@ All these 3 share 1 standard format, commonly called `cfbs.json`.

`index`: URL, relative path, or inline dictionary.
Used by `cfbs add` and `cfbs search`, when index key is present in `cfbs.json` in the current working directory.
When adding a module by URL, which has a cfbs.json inside of it, the index in that file should be ignored.
When adding a module by URL, which has a `cfbs.json` inside of it, the index in that file should be ignored.

## Examples

Expand Down Expand Up @@ -143,8 +143,7 @@ If you put your modules in a repo and don't have them in the index (yet), you ca
"tags": ["local"],
"version": "1.0.0",
"dependencies": ["autorun"],
"steps": ["copy ./test.cf services/autorun/test.cf"],
"added_by": "cfbs add"
"steps": ["copy ./test.cf services/autorun/test.cf"]
}
}
}
Expand Down

0 comments on commit 5ea509e

Please sign in to comment.