Skip to content

Commit

Permalink
Merge pull request #38 from testthedocs/release_0.0.3
Browse files Browse the repository at this point in the history
Merge 0.0.3 release branch
  • Loading branch information
sven committed Mar 14, 2019
2 parents 0f09cde + f677ab0 commit 3ad7f80
Show file tree
Hide file tree
Showing 530 changed files with 119 additions and 275,453 deletions.
15 changes: 15 additions & 0 deletions .gitattributes
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
# Ignore Git related files
.gitattributes export-ignore
.gitignore export-ignore
.gitmodules
.github

# Ignore CI releated files
.travis.yml

# Ignore others
.goreleaser.yml
netlify.toml
notes


22 changes: 21 additions & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,24 @@
## 0.0.2 (2019-00-00)
## 0.0.3 (2019-00-00)

### Added

### Added

- Go modules [svx]
- Go build version ouput [svx]
- `.gitattributes` [svx]

### Removed

- `dep` and its dependencies [svx]

### Improved

- Docs [svx]
- Docs are build now with Hugo 0.54 [svx]
- Update `go` to 1.12 [svx]

## 0.0.2 (2019-01-22)

## Improved

Expand Down
162 changes: 0 additions & 162 deletions Gopkg.lock

This file was deleted.

42 changes: 0 additions & 42 deletions Gopkg.toml

This file was deleted.

4 changes: 2 additions & 2 deletions Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -60,11 +60,11 @@ binary: ## Creating builds (binaries)
@echo ""
@echo "$(YELLOW)==> Done ! binaries for $(VERSION) are created in $(PKG_DIR) $(RESET)"

.PHONY: dep-update
.PHONY: update
dep-update: ## Update go libs with dep
@echo ""
@echo "$(YELLOW)==> Updating go libs $(VERSION)$(RESET)"
@dep ensure -u
@go mod tidy

.PHONY: release
release: binary ## Release go binary using GitReleaser
Expand Down
2 changes: 1 addition & 1 deletion VERSION
Original file line number Diff line number Diff line change
@@ -1 +1 @@
v0.0.2
v0.0.3
1 change: 1 addition & 0 deletions cmd/version.go
Original file line number Diff line number Diff line change
Expand Up @@ -48,6 +48,7 @@ Version, Build Date and Git Commit.`,
fmt.Printf("Git Commit: %s\n", GitCommit)
fmt.Printf("OS: %s\n", runtime.GOOS)
fmt.Printf("Arch: %s\n", runtime.GOARCH)
fmt.Printf("Go Version: %s\n", runtime.Version())
},
}

Expand Down
6 changes: 3 additions & 3 deletions docs/content/contributing.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ Reference points about contributing and developing.

We use [gox](https://github.com/mitchellh/gox) in combination with [ghr](https://github.com/tcnksm/ghr/).

Follow the steps below to make a new release !
Follow the steps below to make a new release!

## Release Notes

Expand All @@ -32,13 +32,13 @@ We use as naming scheme the version number, that means the release notes for ver

### GitHub API Token

To use ``ghr``, you need to get a GitHub token with an account which has enough permissions to to create releases.
To use ``ghr``, you need to get a GitHub token with an account which has enough permissions to create releases.
To get token, first, visit GitHub account settings page, then go to Applications for the user.

Here you can create a token in the Personal access tokens section.
For a private repository you need *repo* scope and for a public repository you need *public_repo* scope.

When using ``ghr``, you can set it via GITHUB_TOKEN env var, -token command line option or github.token property in .gitconfig file.
When using ``ghr``, you can set it via the "GITHUB_TOKEN" env var, -token command line option or github.token property in .gitconfig file.

We use a ``.env`` file which is **ignored** by git, check the ``Makefile`` for more information.

Expand Down
19 changes: 10 additions & 9 deletions docs/content/install.md
Original file line number Diff line number Diff line change
Expand Up @@ -58,12 +58,14 @@ mv edic_darwin_amd64 edic
# Make it 'runnable'
chmod +x edic

# Verify that it runs
# Verify that it runs, you should see something like below

./edic version
Version: v0.0.2
Build Date: 2019-01-18
Git Commit: 1d81e6e
OS: darwin

Version: v0.0.3
Build Date: 2019-03-11
Git Commit: 8d3c8e3
OS: linux
Arch: amd64
```

Expand Down Expand Up @@ -106,7 +108,7 @@ You’ve successfully installed Edic.
### Prerequisite Tools

- [Go (at least Go 1.11)](https://golang.org/)
- [Go (at least Go 1.12)](https://golang.org/)

```sh
go get github.com/testthedocs/edic
Expand All @@ -120,13 +122,12 @@ go get github.com/testthedocs/edic
### Prerequisite Tools

- [Git](http://git-scm.com/)
- [Go (at least Go 1.11)](https://golang.org/)
- [Dep](https://github.com/golang/dep/)
- [Go (at least Go 1.12)](https://golang.org/)

```sh
git clone https://github.com/testthedocs/edic.git
cd edic
dep ensure -u
make install
```

After that, the `edic` binary will be in your `$GOBIN` folder.
Expand Down
13 changes: 13 additions & 0 deletions go.mod
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
module github.com/testthedocs/edic

go 1.12

require (
github.com/BurntSushi/toml v0.3.1 // indirect
github.com/inconshreveable/mousetrap v1.0.0 // indirect
github.com/mitchellh/go-homedir v1.0.0
github.com/spf13/afero v1.2.0 // indirect
github.com/spf13/cobra v0.0.3
github.com/spf13/viper v1.3.1
golang.org/x/sys v0.0.0-20190114130336-2be517255631 // indirect
)
Loading

0 comments on commit 3ad7f80

Please sign in to comment.