Skip to content

Commit bacf09b

Browse files
committed
Remove old repo-smith supports
Remove old repo-smith integration tests Remove old repo-smith unit tests Clean up README Remove specification No longer require it since we're not maintaining the specification. Documentation should come in the form of docstrings now. Fix new repo-smith unit tests
1 parent 8e3f7a1 commit bacf09b

58 files changed

Lines changed: 1 addition & 2885 deletions

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

README.md

Lines changed: 1 addition & 53 deletions
Original file line numberDiff line numberDiff line change
@@ -1,61 +1,9 @@
11
# repo-smith
22

3-
YAML-based configuration for Git repository initialization for unit testing
3+
Declarative syntax for initializing Git repositories.
44

55
## Installation
66

77
```bash
88
pip install -U repo-smith
99
```
10-
11-
## Usage
12-
13-
Create a new configuration file (following the [specification](/specification.md)).
14-
15-
```yml
16-
# File path: tests/specs/basic_spec.yml
17-
name: Basic spec
18-
description: Starting basic spec
19-
initialization:
20-
steps:
21-
- name: Create filea.txt
22-
type: new-file
23-
filename: filea.txt
24-
contents: |
25-
Hello world
26-
- name: Add filea.txt
27-
type: add
28-
files:
29-
- filea.txt
30-
- name: Initial commit
31-
type: commit
32-
message: Initial commit
33-
id: initial-commit
34-
- name: v0 tag
35-
type: tag
36-
tag-name: v0
37-
```
38-
39-
Create a unit test accordingly.
40-
41-
```py
42-
from repo_smith.initialize_repo import initialize_repo
43-
from git import Repo
44-
45-
def test_dummy():
46-
repo_initializer = initialize_repo("test/specs/basic_spec.yml")
47-
with repo_initializer.initialize() as repo:
48-
# All unit testing code for the dummy repository goes here
49-
print(repo)
50-
```
51-
52-
For more use cases of `repo-smith`, refer to:
53-
54-
- [Official specification](/specification.md)
55-
- [Unit tests](./tests/)
56-
57-
## FAQ
58-
59-
### Why don't you assign every error to a constant and unit test against the constant?
60-
61-
Suppose the constant was `X`, and we unit tested that the error value was `X`, we would not capture any nuances if the value of `X` had changed by accident.

0 commit comments

Comments
 (0)