This action clones protobuf files from a (public/private) github repository, generate swagger v2.0 api docs using buf & grpc-gateway's protoc-gen-openapiv2 plugin, and finally upload the generated documentation to aws S3.

Required git token to use for cloning the repository containing the protobuf files

Required protobuf files github repository including the org name

Required branch to clone

Required path to file containing list of subdirectories of protos to clone

Required s3 bucket name

Required aws access key id

Required aws access key secret

Required aws region

Required destination s3 directory

another directory will be created in the destination directory with the name of the repository running this action. The generated documentation will be uploaded to this directory with branch name as the name of the file.

NA

- uses: actions/checkout@v2
- uses: krantideep95/[email protected]
  with:
    GIT_TOKEN: ${{ secrets.GIT_TOKEN }}
    PROTO_REPOSITORY: krantideep95/proto
    PROTO_BRANCH: test
    MODULE_LIST_FILE_PATH: scripts/proto_modules
    AWS_S3_BUCKET: apidocs
    AWS_ACCESS_KEY_ID: ${{ secrets.AWS_ACCESS_KEY_ID }}
    AWS_SECRET_ACCESS_KEY: ${{ secrets.AWS_SECRET_ACCESS_KEY }}
    AWS_REGION: ap-south-1
    DEST_DIR: _docs