Skip to content
New issue

Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? # to your account

Add make test commands and update docs #27

Merged
merged 3 commits into from
Sep 8, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .github/workflows/test-integration.yml
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ jobs:
- uses: actions/checkout@v3
with:
submodules: true
- run: ./test/bats/bin/bats test/test.bats
- run: make test-system
env:
PORKBUN_API_KEY: ${{ secrets.PORKBUN_API_KEY }}
PORKBUN_SECRET_KEY: ${{ secrets.PORKBUN_SECRET_KEY }}
2 changes: 1 addition & 1 deletion .github/workflows/test-pr.yml
Original file line number Diff line number Diff line change
Expand Up @@ -12,4 +12,4 @@ jobs:
with:
go-version: '1.19'
- uses: actions/checkout@v3
- run: go test ./...
- run: make test-unit
7 changes: 7 additions & 0 deletions Makefile
Original file line number Diff line number Diff line change
@@ -1,5 +1,12 @@
build:
go build -o bin/bacon .

test-unit:
go test ./...

test-system: build
git submodule update --init
./test/bats/bin/bats test/test.bats

clean:
rm -rf bin
17 changes: 17 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -104,6 +104,23 @@ records:
- `domain`
- `records`

## Contributing

PRs that add new DNS providers or address [open issues](https://github.com/jungaretti/bacon/issues) are always welcome.

### Development

```bash
# Build Bacon
make build

# Run unit tests
make test-unit

# Run system tests (auth required)
make test-system
```

## Built With

- [Cobra](https://cobra.dev/)
Expand Down