shared

module
v0.0.0-...-02b3d5f Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Feb 3, 2021 License: Apache-2.0

README

Shared

Tools for devs to build.

The tools in this repo are used by all other repos.

SSH local setup

SSH Config file

Needs this in it:


# userXXX
# https://github.com/userXXX/dev
# e.g: git clone git@github.com-userXXX:userXXX/dev.git
Host github.com-userXXX
 HostName github.com
 User git
 UseKeychain yes
 AddKeysToAgent yes
 IdentityFile ~/.ssh/userXXX_github
 

Now you can use the shared tools

Start with the git tooling ..

Fork this repo or any other, and then...

  • To see how a repo is configured:

    • make gitr-print
  • To setup a forked repo automatically:

    • make gitr-fork-setup
  • To catchup a forked repo to Origin:

    • make gitr-fork-catchup
  • To commit changes to a forked repo:

    • make M='commit message' gitr-fork-all

Now you can build any of the code

All the code in all the repos does lots of code gen and so you need our tools to help.

Every repo including this one follows the same pattern with:

  • To Build everything:

    • make this-all
  • To see the status:

    • make this-print
  • To install all our tools:

    • make this-dep
  • To install all our tools:

    • make this-dep

CI

The github actions just call the make files, so that you can run CI locally, and not go nuts 2nd guessing what the github actions are doing...

  • To Build everything:

    • make this-all
  • To Release everything:

    • make this-release

Directories

Path Synopsis
servers
tool
protodoc/cmd command
protoc-gen-doc is used to generate documentation from comments in your proto files.
protoc-gen-doc is used to generate documentation from comments in your proto files.
bs-crypt module

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL