go.chromium.org/luci@v0.0.0-20240309015107-7cdc2e660f33/luciexe/exe/doc.go (about)

     1  // Copyright 2019 The LUCI Authors.
     2  //
     3  // Licensed under the Apache License, Version 2.0 (the "License");
     4  // you may not use this file except in compliance with the License.
     5  // You may obtain a copy of the License at
     6  //
     7  //      http://www.apache.org/licenses/LICENSE-2.0
     8  //
     9  // Unless required by applicable law or agreed to in writing, software
    10  // distributed under the License is distributed on an "AS IS" BASIS,
    11  // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    12  // See the License for the specific language governing permissions and
    13  // limitations under the License.
    14  
    15  // Package exe implements a client for the LUCI Executable ("luciexe") protocol.
    16  //
    17  // The simplest luciexe is:
    18  //
    19  //	import (
    20  //	  "context"
    21  //
    22  //	  "go.chromium.org/luci/luciexe/exe"
    23  //
    24  //	  bbpb "go.chromium.org/luci/buildbucket/proto"
    25  //	)
    26  //
    27  //	func main() {
    28  //	  exe.Run(func(ctx context.Context, input *bbpb.Build, userArgs []string, send exe.BuildSender) error {
    29  //	    ... do whatever you want here ...
    30  //	    return nil // nil error indicates successful build.
    31  //	  })
    32  //	}
    33  //
    34  // See Also: https://go.chromium.org/luci/luciexe
    35  package exe