update_logs_index

README

Update Logs Index

This is a simple tool too generate a markdown file, based on the contents of the distributor's config file, to serve as a human-readable index into the logs/ directory.

Usage

Add the following step config to your distributor's "main" github workflow (before the stefanzweifel/git-auto-commit-action step):

    - name: Update logs index
      id: update_logs_index
      uses: google/trillian-examples/serverless/deploy/github/distributor/update_logs_index@HEAD
      with:
          distributor_dir:  ## Path to your distributor's root directory here
          config: 'config.yaml'
          output: 'logs/README.md'

Documentation

Overview

update_logs_index is a tool to manage a markdown file containing a list of human-readable links to the log directories maintained by the distributor.