Skip to content

Commit

Permalink
(#1) Project skeleton
Browse files Browse the repository at this point in the history
  • Loading branch information
llorllale committed Feb 16, 2019
1 parent 8619bf2 commit 948ed35
Show file tree
Hide file tree
Showing 4 changed files with 24 additions and 4 deletions.
3 changes: 3 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -9,3 +9,6 @@ gitlint

" test coverage
coverage.txt

" PDD output file
puzzles.xml
4 changes: 3 additions & 1 deletion .travis.yml
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,9 @@ dist: trusty
language: go
go:
- "1.11.x"

install:
- gem install pdd
- curl -sfL https://install.goreleaser.com/github.com/golangci/golangci-lint.sh | sh -s v1.14.0
jobs:
include:
- if: (type = pull_request) OR (type = push AND branch = master)
Expand Down
9 changes: 6 additions & 3 deletions Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,8 @@
# build: builds the binary
# test: runs tests
# lint: runs linters
# checks: runs build+test+lint
# pdd: runs pdd (see https://github.com/yegor256/pdd)
# checks: runs build+test+pdd+lint
# release: releases to GitHub (requires GitHub token)
#

Expand All @@ -31,10 +32,12 @@ test:
go test -count=1 -race -cover -coverprofile=coverage.txt -covermode=atomic ./...

lint:
curl -sfL https://install.goreleaser.com/github.com/golangci/golangci-lint.sh | sh -s v1.14.0
./bin/golangci-lint run -v

checks: build lint test
pdd:
pdd --file=puzzles.xml

checks: build lint pdd test

release:
./release.sh
12 changes: 12 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,3 +19,15 @@ As an architect of other (not necessarily golang) projects hosted on GitHub I ne
* Lint commit msgs on varios development platforms (Windows, Linux, Mac)
* (BONUS) Pre-commit hook to validate my commit's msg
* (BONUS) Performance (because a slow pre-commit hook would render the git workflow unmanageable)

## Contributing
Just open a PR, make sure `make checks` works.

## Dependencies
To run `make checks` you will need:

* Go `1.11.x`
* Python 2.7+ (for `pdd`)
* [pdd](https://github.com/yegor256/pdd) (a python gem - `gem install pdd`)
* [golangci-lint](https://github.com/golangci/golangci-lint) v1.14.0 (expected to be in the `./bin` folder)

1 comment on commit 948ed35

@0pdd
Copy link

@0pdd 0pdd commented on 948ed35 Feb 16, 2019

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Puzzle 1-919cdc44 discovered in .golangci.yml and submitted as #3. Please, remember that the puzzle was not necessarily added in this particular commit. Maybe it was added earlier, but we discovered it only now.

Please sign in to comment.