Skip to content

Commit

Permalink
Update readme to reflect go mod usage
Browse files Browse the repository at this point in the history
  • Loading branch information
Blagoj Atanasovski authored and JamesGuthrie committed Oct 11, 2023
1 parent 04c5d4a commit 8043db0
Show file tree
Hide file tree
Showing 4 changed files with 20 additions and 12 deletions.
2 changes: 2 additions & 0 deletions .travis.yml
Original file line number Diff line number Diff line change
@@ -1,7 +1,9 @@
language: go

go:
- 1.11.x
- 1.12.x
- 1.13.x
services:
- docker
install: true
Expand Down
24 changes: 15 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,19 +24,25 @@ This repo contains code for exporting complete InfluxDB databases or selected me

### Installing from source

Outflux is a Go project managed by `dep` (The go dependency management tool). To download the proper dependency versions, `dep` must be installed on your system. Instructions can be found on the [official documentation page](https://golang.github.io/dep/docs/installation.html).
Outflux is a Go project managed by `go modules`. You can download it
in any directory and on the first build it will download it's required dependencies.

Depending on where you downloaded it and the go version you're using, you may
need to set the `GO111MODULE` to `auto`, `on` or `off`. Learn about the `GO111MODULE`
environment variable [here](https://golang.org/cmd/go/#hdr-Module_support).

```bash
# Fetch the source code of Outflux
$ go get github.com/timescale/outflux
$ cd $GOPATH/src/github.com/timescale/outflux
# Fetch the source code of Outflux in any directory
$ git clone git@github.com:timescale/outflux.git
$ cd ./outflux

# Fetch the required dependencies
$ dep ensure -v
# Install the Outflux binary (will automaticly detect and download)
# dependencies.
$ cd cmd/outflux
$ GO111MODULE=auto go install

# Install the Outflux binary:
$ cd cmd/outlux
$ go install
# Building without installing will also fetch the required dependencies
$ GO111MODULE=auto go build ./...
```

### Binary releases
Expand Down
2 changes: 1 addition & 1 deletion cmd/outflux/main.go
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
package main

const outfluxVersion = "0.2.0"
const outfluxVersion = "0.2.0-dev"

func main() {
RootCmd.Execute()
Expand Down
4 changes: 2 additions & 2 deletions internal/schemamanagement/ts/ts_schema_manager.go
Original file line number Diff line number Diff line change
Expand Up @@ -190,7 +190,7 @@ func (sm *TSSchemaManager) updateMetadata() {

err = sm.creator.UpdateMetadata(sm.dbConn, metadataTableName)
if err != nil {
log.Println("could not update TimescaleDB metadata")
log.Println("reason:" + err.Error())
log.Println("WARN: could not update TimescaleDB metadata")
log.Println("WARN: reason:" + err.Error())
}
}

0 comments on commit 8043db0

Please sign in to comment.