Vendor generated file #1464

vdemeester · 2017-04-19T17:43:22Z

The main reason is : allows compilation (and go test -v, …) on non-unix systems (like windows).
We already vendor dependencies so… 👼

Signed-off-by: Vincent Demeester vincent@sbr.pm

timoreimann · 2017-04-19T18:27:09Z

When do developers need to re-run the auto-generation step?

The docs should probably be updated in this regard.

emilevauge

@vdemeester Could you modify CONTRIBUTING.md accordingly ?

vdemeester · 2017-04-20T07:31:34Z

@emilevauge yes I can 👼 I also want to add a check (like validate glide) for it (i.e. if a template changes in the commit/diff, validates that the autogen file is correct). But first I need to update validate-gofmt 😂

timoreimann · 2017-04-20T07:36:30Z

Good point about the extra validation script we need. 👍

vdemeester · 2017-04-20T09:13:15Z

Updated with the validate files 👼

timoreimann

Left mostly questions.

timoreimann · 2017-04-20T10:33:45Z

script/validate-autogen

@@ -0,0 +1,30 @@
+#!/bin/bash


/usr/bin/env bash is preferred.

yep I know, all other scripts are /bin/bash so.. I did a mimic and was about to do a PR to switch to /usr/bin/env bash

I'd rather see this being updated either for validate-autogen or all scripts right on this PR. Otherwise, chances are the script will not work until you submitted that follow-up PR. (For instance, on my Mac /bin/bash points at the ancient bash 3 version that doesn't work with many features.)

timoreimann · 2017-04-20T10:36:51Z

script/validate-gofmt

@@ -3,7 +3,7 @@
 source "$(dirname "$BASH_SOURCE")/.validate"

 IFS=$'\n'
-files=( $(validate_diff --diff-filter=ACMR --name-only -- '*.go' | grep -v '^\(integration/\)\?vendor/' || true) )
+files=( $(validate_diff --diff-filter=ACMR --name-only -- '*.go' | grep -v '^\(integration/\)\?vendor/\|autogen' || true) )


Did you verify the pipe operator works (that is, it really ignores the autogen file while not breaking the vendor things)?

Last time I tried, I had quite some issues, which is why I'm asking.

Does this now match an autogen file located anywhere in our code base? Is that what we want? Do we need to be more / less specific?

yes for the first questio.
to test for the 2nd 👼

it's ok for the second (i.e. provider/autogen.go for ex isn't exclude by this and this will be verified)

timoreimann · 2017-04-20T10:38:39Z

.github/CONTRIBUTING.md

@@ -72,6 +72,10 @@ $ gox "linux darwin" "386 amd64 arm" \
 # run other commands like tests
 ```

+### Updating the templates
+
+If you happen to update the provider templates (in `/templates`), you need to run `go generate` to update the `autogen` package.


Another comment in the file mentions that the generation step is required for the web UI. If that's true, we should mention it there as well and possibly update the other comment.

I'll look 👼

timoreimann

Two points left, half-suggestion/half-requirement. :-)

timoreimann · 2017-04-21T09:05:10Z

.github/CONTRIBUTING.md

@@ -61,7 +61,8 @@ Here's a full example:
 $ ./script/glide.sh get github.com/foo/bar
 # install another dependency, this time for the integration tests
 $ ( cd integration && ../script/glide.sh get github.com/baz/quuz )
-# generate (Only required to integrate other components such as web dashboard)
+# generate
+# (Only required to integrate other components such as web dashboard and if you change something there — web, templates)


if you change something there [being the dashboard]

The templates aren't really related to the dashboard, are they?

How about rephrasing it like this:

# generate # (required to merge non-code components into the final binary, such as the web dashboard and provider Go templates)

timoreimann · 2017-04-21T09:07:51Z

script/validate-autogen

@@ -0,0 +1,30 @@
+#!/bin/bash


I'd rather see this being updated either for validate-autogen or all scripts right on this PR. Otherwise, chances are the script will not work until you submitted that follow-up PR. (For instance, on my Mac /bin/bash points at the ancient bash 3 version that doesn't work with many features.)

timoreimann · 2017-04-21T09:08:29Z

script/validate-gofmt

@@ -3,7 +3,7 @@
 source "$(dirname "$BASH_SOURCE")/.validate"

 IFS=$'\n'
-files=( $(validate_diff --diff-filter=ACMR --name-only -- '*.go' | grep -v '^\(integration/\)\?vendor/' || true) )
+files=( $(validate_diff --diff-filter=ACMR --name-only -- '*.go' | grep -v '^\(integration/\)\?vendor/\|autogen' || true) )


timoreimann

LGTM. 👏

vdemeester · 2017-04-24T15:15:31Z

ping @containous/traefik 👼 (I'll rebase once I have enough LGTM…)

ldez · 2017-04-28T08:33:07Z

@vdemeester it's time to rebase! 😃

emilevauge · 2017-04-28T12:01:11Z

script/validate-autogen

+SCRIPTDIR="$( cd "$( dirname "${BASH_SOURCE[0]}" )" && pwd )"; export SCRIPTDIR
+source "${SCRIPTDIR}/.validate"
+
+# Iterate over all directories containing vendor folders.


s/vendor/templates ?

Signed-off-by: Vincent Demeester <vincent@sbr.pm>

… instead of /bin/bash, to work better on more platforms. Signed-off-by: Vincent Demeester <vincent@sbr.pm>

emilevauge · 2017-05-02T20:01:19Z

@vdemeester, As discussing with @ldez, it seems the validation script is incomplete and lacks webui checks (in go generate: go-bindata -pkg autogen -o autogen/gen.go ./static/... ./templates/...).
But adding a webui check in validation will be a lot slower, building webui takes some time.
WDYT? revert?

vdemeester added the status/2-needs-review label Apr 19, 2017

vdemeester requested review from errm, timoreimann, SantoDE, Russell-IO, emilevauge and dtomcej April 19, 2017 17:43

emilevauge requested changes Apr 20, 2017

View reviewed changes

vdemeester force-pushed the vendor-autogen branch from 755cf18 to fef2346 Compare April 20, 2017 08:05

vdemeester force-pushed the vendor-autogen branch from fef2346 to c1fd672 Compare April 20, 2017 09:38

timoreimann suggested changes Apr 20, 2017

View reviewed changes

vdemeester force-pushed the vendor-autogen branch from c1fd672 to 765a237 Compare April 21, 2017 08:36

timoreimann reviewed Apr 21, 2017

View reviewed changes

vdemeester force-pushed the vendor-autogen branch from 765a237 to c106513 Compare April 21, 2017 09:24

timoreimann approved these changes Apr 21, 2017

View reviewed changes

ldez added contributor/waiting-for-corrections status/3-docs-review and removed status/2-needs-review labels Apr 24, 2017

ldez removed the contributor/waiting-for-corrections label Apr 24, 2017

ldez added this to the 1.3 milestone Apr 25, 2017

ldez approved these changes Apr 28, 2017

View reviewed changes

ldez added status/3-needs-merge and removed status/3-docs-review labels Apr 28, 2017

vdemeester force-pushed the vendor-autogen branch from c106513 to 82730e9 Compare April 28, 2017 10:09

emilevauge reviewed Apr 28, 2017

View reviewed changes

ldez added the contributor/waiting-for-corrections label Apr 28, 2017

emilevauge force-pushed the vendor-autogen branch from 82730e9 to 9a8a05d Compare May 1, 2017 16:31

emilevauge approved these changes May 1, 2017

View reviewed changes

emilevauge removed the contributor/waiting-for-corrections label May 1, 2017

vdemeester added 2 commits May 1, 2017 18:32

Vendor generated file

1b85dd0

Signed-off-by: Vincent Demeester <vincent@sbr.pm>

Update script to use /usr/bin/env bash…

65f8199

… instead of /bin/bash, to work better on more platforms. Signed-off-by: Vincent Demeester <vincent@sbr.pm>

emilevauge force-pushed the vendor-autogen branch from 9a8a05d to 65f8199 Compare May 1, 2017 16:32

emilevauge merged commit a0d6594 into traefik:master May 1, 2017

vdemeester deleted the vendor-autogen branch May 1, 2017 17:16

ldez mentioned this pull request May 3, 2017

Revert "Vendor generated file" #1534

Merged

ldez added a commit that referenced this pull request May 3, 2017

Merge pull request #1464 from vdemeester/vendor-autogen

acb0492

ldez added kind/enhancement a new or improved feature. and removed status/3-needs-merge labels May 19, 2017

ldez mentioned this pull request Nov 20, 2017

Vendor generated file from template #2432

Merged

1 task

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Vendor generated file #1464

Vendor generated file #1464

vdemeester commented Apr 19, 2017

timoreimann commented Apr 19, 2017

emilevauge left a comment

vdemeester commented Apr 20, 2017

timoreimann commented Apr 20, 2017

vdemeester commented Apr 20, 2017

timoreimann left a comment

timoreimann Apr 20, 2017

vdemeester Apr 20, 2017

timoreimann Apr 21, 2017

timoreimann Apr 20, 2017

timoreimann Apr 20, 2017

vdemeester Apr 20, 2017

vdemeester Apr 21, 2017

timoreimann Apr 21, 2017

timoreimann Apr 20, 2017

vdemeester Apr 20, 2017

timoreimann left a comment

timoreimann Apr 21, 2017

timoreimann Apr 21, 2017

timoreimann Apr 21, 2017

timoreimann left a comment

vdemeester commented Apr 24, 2017

ldez commented Apr 28, 2017

emilevauge Apr 28, 2017

emilevauge commented May 2, 2017

Vendor generated file #1464

Vendor generated file #1464

Conversation

vdemeester commented Apr 19, 2017

timoreimann commented Apr 19, 2017

emilevauge left a comment

Choose a reason for hiding this comment

vdemeester commented Apr 20, 2017

timoreimann commented Apr 20, 2017

vdemeester commented Apr 20, 2017

timoreimann left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

timoreimann left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

timoreimann left a comment

Choose a reason for hiding this comment

vdemeester commented Apr 24, 2017

ldez commented Apr 28, 2017

Choose a reason for hiding this comment

emilevauge commented May 2, 2017