This template helps developers get started with the Go SDK and initiate indexing process on pkg.go.dev repository
For publishing the package, it is important to note the Go website's Licence Disclaimer. As stated in the document, in case of the missing license, only limited package and module information will be made available on the Go website. You can find more information on license config in our developer docs.
This repository contains the following:
- A
README
that contains the instructions - A GitHub Action workflow to initiate publishing the Go SDK to pkg.go.dev package repository (as suggested in the official publishing tutorial).
-
Create a new target Go SDK Repo by clicking the Use this template button at the top of this repository.
-
Run the GitHub Action
Generate SDKs using liblab
in the Control Repo that builds the SDK, and raises a PR against this target SDK Repo. -
Review and merge the PR.
-
Create a release with a tag in the target SDK Repo.
-
The GitHub Action
Publish to pkg.go.dev
in the target SDK Repo initiates the indexing proces -
After the time needed for the indexing process to be finished (tipically around 1 hour or less), package should be accessible at
https://pkg.go.dev/github.com/{go-module-name}@{tag}