beam-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "ASF GitHub Bot (JIRA)" <j...@apache.org>
Subject [jira] [Work logged] (BEAM-5379) Go Modules versioning support
Date Thu, 13 Sep 2018 17:20:00 GMT

     [ https://issues.apache.org/jira/browse/BEAM-5379?focusedWorklogId=144014&page=com.atlassian.jira.plugin.system.issuetabpanels:worklog-tabpanel#worklog-144014
]

ASF GitHub Bot logged work on BEAM-5379:
----------------------------------------

                Author: ASF GitHub Bot
            Created on: 13/Sep/18 17:19
            Start Date: 13/Sep/18 17:19
    Worklog Time Spent: 10m 
      Work Description: aaltay closed pull request #6387: [BEAM-5379] Add getting started
instructions for go-sdk
URL: https://github.com/apache/beam/pull/6387
 
 
   

This is a PR merged from a forked repository.
As GitHub hides the original diff on merge, it is displayed below for
the sake of provenance:

As this is a foreign pull request (from a fork), the diff is supplied
below (as it won't show otherwise due to GitHub magic):

diff --git a/sdks/go/README.md b/sdks/go/README.md
index f9a08e0b6db..247c287665c 100644
--- a/sdks/go/README.md
+++ b/sdks/go/README.md
@@ -90,4 +90,39 @@ SDK harness container image.
 
 ## Issues
 
-Please use the `sdk-go` component for any bugs or feature requests.
\ No newline at end of file
+Please use the [`sdk-go`](https://issues.apache.org/jira/issues/?jql=project%20%3D%20BEAM%20AND%20resolution%20%3D%20Unresolved%20AND%20component%20%3D%20sdk-go%20ORDER%20BY%20priority%20DESC%2C%20updated%20DESC)
component for any bugs or feature requests.
+
+## Contributing to the Go SDK
+
+### New to developing Go?
+https://tour.golang.org : The Go Tour gives you the basics of the language, interactively
no installation required.
+
+https://github.com/campoy/go-tooling-workshop is a great start on learning good (optional)
development tools for Go. 
+
+### Developing Go Beam SDK on Github
+
+To make and test changes when working with Go, it's neecessary to clone your repository 
+in a subdirectory of your GOPATH. This permits existing gradle tools to use your in progress
changes.
+
+```
+# Create a Go compatible place for the repo, using src/github.com/apache/
+# matches where Go will look for the files, or go get would put them.
+$ mkdir -p $GOPATH/src/github.com/apache/
+$ cd $GOPATH/src/github.com/apache/
+
+
+# Clone the repo, and update your branch as normal
+$ git clone https://github.com/apache/beam.git
+$ cd beam
+$ git remote add <GitHub_user> git@github.com:<GitHub_user>/beam.git
+$ git fetch --all
+
+# Get or Update all the Go SDK dependencies
+$ go get -u ./...
+# Test that the system compiles and runs.
+$ go test ./...
+```
+
+If you don’t have a GOPATH set, create a new directory in your home directory, and use
that.
+
+Follow the [contribution guide](https://beam.apache.org/contribute/contribution-guide/#code)
to create branches, and submit pull requests as normal.


 

----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on GitHub and use the
URL above to go to the specific comment.
 
For queries about this service, please contact Infrastructure at:
users@infra.apache.org


Issue Time Tracking
-------------------

    Worklog Id:     (was: 144014)
    Time Spent: 0.5h  (was: 20m)

> Go Modules versioning support
> -----------------------------
>
>                 Key: BEAM-5379
>                 URL: https://issues.apache.org/jira/browse/BEAM-5379
>             Project: Beam
>          Issue Type: Improvement
>          Components: sdk-go
>            Reporter: Robert Burke
>            Assignee: Robert Burke
>            Priority: Major
>          Time Spent: 0.5h
>  Remaining Estimate: 0h
>
> This would make it easier for non-Go developers to update and test changes to the Go
SDK without jumping through hoops to set up Go Paths at first.
> Right now, we us the gogradle plugin for gradle to handle re-producible builds. Without
doing something with the GO_PATH relative to a user's local git repo though, changes made
in the user's repo are not represented when gradle is invoked to test everything.
> One of at least the following needs to be accomplished:
> * gogradle moves to support the Go Modules experiment in Go 1.11, and the SDK migrates
to that
> * or we re-implement our gradle go rules ourselves to use them, 
> * or some third option, that moves away from the GO_PATH nit.
> This issue should be resolved after deciding and implementing a clear versioning story
for the SDK, ideally along Go best practices.



--
This message was sent by Atlassian JIRA
(v7.6.3#76005)

Mime
View raw message