Skip to content

Commit 0338718

Browse files
authored
Merge pull request glennsarti#34 from glennsarti/logicminds-pr33
Adds git clone method to search for metadata file
2 parents a741f06 + f101158 commit 0338718

File tree

3 files changed

+18
-9
lines changed

3 files changed

+18
-9
lines changed

docs/architecture.md

Lines changed: 6 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -18,11 +18,11 @@ Note that a CLI is included (`puppetfile-cli.rb`) only as an example of how to c
1818
## Architecture
1919

2020
``` text
21-
+-----------------+ +-----------------+ +-----------------+
22-
| Forge Searcher | | Git Searcher | | Local Searcher |
23-
+-------+---------+ +--------+--------+ +-------+---------+
24-
| | |
25-
+----------------------+--------------------+
21+
+-----------------+ +-----------------+ +-----------------+ +---------------------+
22+
| Forge Searcher | | Git Searcher | | Local Searcher | | Other searchers.... |
23+
+-------+---------+ +--------+--------+ +-------+---------+ +----------+----------+
24+
| | | |
25+
+----------------------+--------------------+------------------------+---- ...
2626
|
2727
|
2828
V
@@ -81,7 +81,6 @@ module_list.each do |mod_name|
8181
end
8282
```
8383

84-
8584
### Puppetfile Document Validation
8685

8786
Even though a Puppetfile can be parsed, doesn't mean it's valid. For example, defining a module twice.
@@ -92,7 +91,7 @@ Given a Puppetfile document model, the library can attempt to recursively resolv
9291

9392
### Module Searchers
9493

95-
The Puppetfile resolution needs information about all of the available modules and versions, and does this through calling various Specification Searchers. Currently Puppet Forge, GitHub, GitLab and Local FileSystem searchers are implemented. Additional searchers could be added, for example SVN.
94+
The Puppetfile resolution needs information about all of the available modules and versions, and does this through calling various Specification Searchers. Currently Puppet Forge, GitHub, GitLab, Git Clone and Local FileSystem searchers are implemented. Additional searchers could be added, for example SVN.
9695

9796
The result is a dependency graph listing all of the modules, dependencies and version information.
9897

docs/index.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,18 @@ This library includes all of the code to parse a Puppetfile and then calculate a
2222

2323
**Note** This library is in active development!
2424

25+
## Supported Searchers
26+
27+
See "Module Searchers" in the [Architecture](./architecture) for more information about searchers.
28+
29+
Currently supported searchers:
30+
31+
* Git Clone
32+
* GitHub
33+
* GitLab
34+
* Local FileSystem
35+
* Puppet Forge
36+
2537
## To Do
2638

2739
- Could do with more tests

docs/known_issues.md

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,5 +8,3 @@
88
---
99

1010
- The Forge module searcher will only use the internet facing forge ([https://forge.puppet.com](https://forge.puppet.com/)). Self-hosted forges are not supported
11-
12-
- The Git module searcher will only search public GitHub and GitLab based modules. Private repositories or other VCS systems are not supported

0 commit comments

Comments
 (0)