Skip to content

Commit bf08092

Browse files
committed
Fix the unit tests to release the v0.1.0
1 parent 87be70c commit bf08092

File tree

12 files changed

+722
-110
lines changed

12 files changed

+722
-110
lines changed

.task/checksum/install

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
1b7ffb9a935aa0b08ea1c774c0758749

README.md

Lines changed: 61 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -134,3 +134,64 @@ Please make sure to update tests as appropriate.
134134
## License
135135

136136
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
137+
138+
## Beta Markdown Output (New!)
139+
140+
You can generate a Markdown summary of your Terraform plan with:
141+
142+
```bash
143+
tfsumpy plan.json --markdown > plan_summary.md
144+
```
145+
146+
This will create a Markdown file with sections for summary, created, updated, and destroyed resources, and JSON code blocks for each resource change.
147+
148+
- **Created Resources**: 🟩
149+
- **Updated Resources**: 🟦
150+
- **Destroyed Resources**: 🟥
151+
152+
Each resource is shown as a JSON code block. For updates, both before and after states are shown.
153+
154+
> **Note:** Markdown output is a beta feature. Please report any issues or suggestions!
155+
156+
## Project Status
157+
158+
**Status:** Beta
159+
160+
## Developer Workflow with Taskfile
161+
162+
This project uses [Taskfile](https://taskfile.dev) to simplify common development tasks.
163+
164+
### Install Task
165+
166+
On macOS (with Homebrew):
167+
```bash
168+
brew install go-task/tap/go-task
169+
```
170+
On Linux:
171+
```bash
172+
sh -c "$(curl --location https://taskfile.dev/install.sh)" -- -d
173+
```
174+
175+
### Common Commands
176+
177+
- Run all tests:
178+
```bash
179+
task test
180+
```
181+
- Build the package:
182+
```bash
183+
task build
184+
```
185+
- Run linting:
186+
```bash
187+
task lint
188+
```
189+
- Install all dependencies:
190+
```bash
191+
task install
192+
```
193+
194+
See all available tasks:
195+
```bash
196+
task --list
197+
```

Taskfile.yml

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
version: '3'
2+
3+
tasks:
4+
install:
5+
desc: Install all dependencies (including dev)
6+
cmds:
7+
- python3 -m venv .venv
8+
- . .venv/bin/activate && pip install --upgrade pip
9+
- . .venv/bin/activate && pip install -e ".[dev]"
10+
- . .venv/bin/activate && pip install build
11+
sources:
12+
- pyproject.toml
13+
- requirements.txt
14+
generates:
15+
- .venv
16+
17+
test:
18+
desc: Run all tests with pytest
19+
cmds:
20+
- . .venv/bin/activate && pytest
21+
deps: [install]
22+
23+
lint:
24+
desc: Run linting (pylint and mypy)
25+
cmds:
26+
- . .venv/bin/activate && pylint tfsumpy
27+
- . .venv/bin/activate && mypy tfsumpy
28+
deps: [install]
29+
30+
build:
31+
desc: Build the package
32+
cmds:
33+
- . .venv/bin/activate && python -m build
34+
deps: [install]

docs/index.md

Lines changed: 23 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -80,4 +80,26 @@ We welcome contributions! See our [Contributing Guide](contributing.md) for deta
8080

8181
## License
8282

83-
tfsumpy is released under the MIT License. See the [LICENSE](https://github.com/rafaelherik/tfsumpy/blob/main/LICENSE) file for details.
83+
tfsumpy is released under the MIT License. See the [LICENSE](https://github.com/rafaelherik/tfsumpy/blob/main/LICENSE) file for details.
84+
85+
## Beta Markdown Output (New!)
86+
87+
You can generate a Markdown summary of your Terraform plan with:
88+
89+
```bash
90+
tfsumpy plan.json --markdown > plan_summary.md
91+
```
92+
93+
This will create a Markdown file with sections for summary, created, updated, and destroyed resources, and JSON code blocks for each resource change.
94+
95+
- **Created Resources**: 🟩
96+
- **Updated Resources**: 🟦
97+
- **Destroyed Resources**: 🟥
98+
99+
Each resource is shown as a JSON code block. For updates, both before and after states are shown.
100+
101+
> **Note:** Markdown output is a beta feature. Please report any issues or suggestions!
102+
103+
## Project Status
104+
105+
**Status:** Beta

docs/usage/advanced_usage.md

Lines changed: 18 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -73,4 +73,21 @@ bolwerk plan.json --debug
7373
This enables:
7474
- Verbose logging
7575
- Detailed error messages
76-
- Analysis process information
76+
- Analysis process information
77+
78+
## Markdown Output (Beta)
79+
80+
You can generate a Markdown summary of your Terraform plan with:
81+
82+
```bash
83+
tfsumpy plan.json --markdown > plan_summary.md
84+
```
85+
86+
This will create a Markdown file with:
87+
- A summary section
88+
- Sections for created, updated, and destroyed resources
89+
- JSON code blocks for each resource change
90+
91+
For updates, both before and after states are shown. For creates and deletes, only the relevant state is shown.
92+
93+
> **Note:** Markdown output is a beta feature. Please report any issues or suggestions!

makefile

Lines changed: 0 additions & 82 deletions
This file was deleted.

0 commit comments

Comments
 (0)