Skip to content

Use a more standard folder architecture #113

New issue

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

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

Already on GitHub? Sign in to your account

Closed
wants to merge 2 commits into from
Closed
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
32 changes: 29 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,32 @@ See [Doing continuous integration with arduino builder](https://github.com/ardui

You need [Go 1.4.3](https://golang.org/dl/#go1.4.3).

Repo root contains the script `setup_go_env_vars`. Use it as is or as a template for setting up Go environment variables.
If you want a clean Gopath you can start by creating a directory wherever you want

```bash
$ mkdir abuilder
$ cd abuilder
```

And set the GOPATH to that directory

```bash
$ export GOPATH=`pwd`
```

Then you can clone this repository in the folder

```bash
$ go get github.com/arduino/arduino-builder
```

If you instead need to clone a private fork you can use this method:

```bash
$ mkdir -p src/github.com/arduino
$ cd src/github.com/arduino
$ git clone git@github.com:myusername/arduino-builder.git
```

To install `codereview/patch` you have to install [Mercurial](https://www.mercurial-scm.org/) first.

Expand All @@ -77,12 +102,13 @@ go build
In order to run the tests, type:

```
go test -timeout 60m -v ./src/arduino.cc/builder/test/...
go test -timeout 60m -v ./builder/test/...
```

In jenkins, use

```
go test -timeout 60m -v ./src/arduino.cc/builder/test/... | bin/go-junit-report > report.xml
go test -timeout 60m -v ./builder/test/... | bin/go-junit-report > report.xml
```

### License and Copyright
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -30,9 +30,9 @@
package builder

import (
"arduino.cc/builder/constants"
"arduino.cc/builder/types"
"arduino.cc/builder/utils"
"github.com/arduino/arduino-builder/builder/constants"
"github.com/arduino/arduino-builder/builder/types"
"github.com/arduino/arduino-builder/builder/utils"
"path/filepath"
)

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -30,9 +30,9 @@
package builder

import (
"arduino.cc/builder/constants"
"arduino.cc/builder/i18n"
"arduino.cc/builder/types"
"github.com/arduino/arduino-builder/builder/constants"
"github.com/arduino/arduino-builder/builder/i18n"
"github.com/arduino/arduino-builder/builder/types"
"os"
"strings"
)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -30,9 +30,9 @@
package builder

import (
"arduino.cc/builder/constants"
"arduino.cc/builder/props"
"arduino.cc/builder/types"
"github.com/arduino/arduino-builder/builder/constants"
"github.com/arduino/arduino-builder/builder/props"
"github.com/arduino/arduino-builder/builder/types"
)

type AddMissingBuildPropertiesFromParentPlatformTxtFiles struct{}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -30,9 +30,9 @@
package builder

import (
"arduino.cc/builder/constants"
"arduino.cc/builder/types"
"arduino.cc/builder/utils"
"github.com/arduino/arduino-builder/builder/constants"
"github.com/arduino/arduino-builder/builder/types"
"github.com/arduino/arduino-builder/builder/utils"
"bytes"
"io/ioutil"
"path/filepath"
Expand Down
8 changes: 4 additions & 4 deletions src/arduino.cc/builder/builder.go → builder/builder.go
Original file line number Diff line number Diff line change
Expand Up @@ -30,10 +30,10 @@
package builder

import (
"arduino.cc/builder/constants"
"arduino.cc/builder/phases"
"arduino.cc/builder/types"
"arduino.cc/builder/utils"
"github.com/arduino/arduino-builder/builder/constants"
"github.com/arduino/arduino-builder/builder/phases"
"github.com/arduino/arduino-builder/builder/types"
"github.com/arduino/arduino-builder/builder/utils"
"os"
"reflect"
"strconv"
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -30,10 +30,10 @@
package builder_utils

import (
"arduino.cc/builder/constants"
"arduino.cc/builder/i18n"
"arduino.cc/builder/props"
"arduino.cc/builder/utils"
"github.com/arduino/arduino-builder/builder/constants"
"github.com/arduino/arduino-builder/builder/i18n"
"github.com/arduino/arduino-builder/builder/props"
"github.com/arduino/arduino-builder/builder/utils"
"bytes"
"fmt"
"os"
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -30,10 +30,10 @@
package builder

import (
"arduino.cc/builder/constants"
"arduino.cc/builder/i18n"
"arduino.cc/builder/props"
"arduino.cc/builder/utils"
"github.com/arduino/arduino-builder/builder/constants"
"github.com/arduino/arduino-builder/builder/i18n"
"github.com/arduino/arduino-builder/builder/props"
"github.com/arduino/arduino-builder/builder/utils"
"fmt"
"path/filepath"
"regexp"
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -30,10 +30,10 @@
package builder

import (
"arduino.cc/builder/constants"
"arduino.cc/builder/gohasissues"
"arduino.cc/builder/types"
"arduino.cc/builder/utils"
"github.com/arduino/arduino-builder/builder/constants"
"github.com/arduino/arduino-builder/builder/gohasissues"
"github.com/arduino/arduino-builder/builder/types"
"github.com/arduino/arduino-builder/builder/utils"
"io/ioutil"
"os"
"path/filepath"
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -30,9 +30,9 @@
package builder

import (
"arduino.cc/builder/constants"
"arduino.cc/builder/types"
"arduino.cc/builder/utils"
"github.com/arduino/arduino-builder/builder/constants"
"github.com/arduino/arduino-builder/builder/types"
"github.com/arduino/arduino-builder/builder/utils"
"strings"
)

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -30,8 +30,8 @@
package builder

import (
"arduino.cc/builder/constants"
"arduino.cc/builder/types"
"github.com/arduino/arduino-builder/builder/constants"
"github.com/arduino/arduino-builder/builder/types"
)

type ComparePrototypesFromSourceAndPreprocSource struct{}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -30,10 +30,10 @@
package builder

import (
"arduino.cc/builder/constants"
"arduino.cc/builder/ctags"
"arduino.cc/builder/types"
"arduino.cc/builder/utils"
"github.com/arduino/arduino-builder/builder/constants"
"github.com/arduino/arduino-builder/builder/ctags"
"github.com/arduino/arduino-builder/builder/types"
"github.com/arduino/arduino-builder/builder/utils"
)

type ContainerAddPrototypes struct{}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -30,8 +30,8 @@
package builder

import (
"arduino.cc/builder/types"
"arduino.cc/builder/utils"
"github.com/arduino/arduino-builder/builder/types"
"github.com/arduino/arduino-builder/builder/utils"
)

type ContainerBuildOptions struct{}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -30,9 +30,9 @@
package builder

import (
"arduino.cc/builder/constants"
"arduino.cc/builder/types"
"arduino.cc/builder/utils"
"github.com/arduino/arduino-builder/builder/constants"
"github.com/arduino/arduino-builder/builder/types"
"github.com/arduino/arduino-builder/builder/utils"
"path/filepath"
)

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -30,8 +30,8 @@
package builder

import (
"arduino.cc/builder/types"
"arduino.cc/builder/utils"
"github.com/arduino/arduino-builder/builder/types"
"github.com/arduino/arduino-builder/builder/utils"
)

type ContainerMergeCopySketchFiles struct{}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -30,8 +30,8 @@
package builder

import (
"arduino.cc/builder/types"
"arduino.cc/builder/utils"
"github.com/arduino/arduino-builder/builder/types"
"github.com/arduino/arduino-builder/builder/utils"
)

type ContainerSetupHardwareToolsLibsSketchAndProps struct{}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -30,8 +30,8 @@
package builder

import (
"arduino.cc/builder/constants"
"arduino.cc/builder/utils"
"github.com/arduino/arduino-builder/builder/constants"
"github.com/arduino/arduino-builder/builder/utils"
"encoding/json"
"reflect"
"strings"
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -30,9 +30,9 @@
package ctags

import (
"arduino.cc/builder/constants"
"arduino.cc/builder/types"
"arduino.cc/builder/utils"
"github.com/arduino/arduino-builder/builder/constants"
"github.com/arduino/arduino-builder/builder/types"
"github.com/arduino/arduino-builder/builder/utils"
"os"
"reflect"
"runtime"
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -30,10 +30,10 @@
package ctags

import (
"arduino.cc/builder/constants"
"arduino.cc/builder/i18n"
"arduino.cc/builder/props"
"arduino.cc/builder/utils"
"github.com/arduino/arduino-builder/builder/constants"
"github.com/arduino/arduino-builder/builder/i18n"
"github.com/arduino/arduino-builder/builder/props"
"github.com/arduino/arduino-builder/builder/utils"
"fmt"
)

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -30,8 +30,8 @@
package ctags

import (
"arduino.cc/builder/constants"
"arduino.cc/builder/types"
"github.com/arduino/arduino-builder/builder/constants"
"github.com/arduino/arduino-builder/builder/types"
"strings"
)

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -30,8 +30,8 @@
package builder

import (
"arduino.cc/builder/constants"
"arduino.cc/builder/utils"
"github.com/arduino/arduino-builder/builder/constants"
"github.com/arduino/arduino-builder/builder/utils"
"path/filepath"
)

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -30,9 +30,9 @@
package builder

import (
"arduino.cc/builder/constants"
"arduino.cc/builder/props"
"arduino.cc/builder/utils"
"github.com/arduino/arduino-builder/builder/constants"
"github.com/arduino/arduino-builder/builder/props"
"github.com/arduino/arduino-builder/builder/utils"
"fmt"
"sort"
)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@
package builder

import (
"arduino.cc/builder/utils"
"github.com/arduino/arduino-builder/builder/utils"
"fmt"
"sort"
)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -30,8 +30,8 @@
package builder

import (
"arduino.cc/builder/constants"
"arduino.cc/builder/utils"
"github.com/arduino/arduino-builder/builder/constants"
"github.com/arduino/arduino-builder/builder/utils"
)

type EnsureBuildPathExists struct{}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@
package builder

import (
"arduino.cc/builder/constants"
"github.com/arduino/arduino-builder/builder/constants"
"path/filepath"
"strings"
)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -30,8 +30,8 @@
package builder

import (
"arduino.cc/builder/constants"
"arduino.cc/builder/utils"
"github.com/arduino/arduino-builder/builder/constants"
"github.com/arduino/arduino-builder/builder/utils"
"path/filepath"
)

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -30,10 +30,10 @@
package builder

import (
"arduino.cc/builder/constants"
"arduino.cc/builder/i18n"
"arduino.cc/builder/types"
"arduino.cc/builder/utils"
"github.com/arduino/arduino-builder/builder/constants"
"github.com/arduino/arduino-builder/builder/i18n"
"github.com/arduino/arduino-builder/builder/types"
"github.com/arduino/arduino-builder/builder/utils"
"os"
"path/filepath"
)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -30,8 +30,8 @@
package builder

import (
"arduino.cc/builder/constants"
"arduino.cc/builder/utils"
"github.com/arduino/arduino-builder/builder/constants"
"github.com/arduino/arduino-builder/builder/utils"
"strings"
)

Expand Down
Loading