launchdarkly / ld-find-code-refs

Build tool for automatically sending feature flag code references to LaunchDarkly
https://launchdarkly.com
Other
46 stars 34 forks source link

[sc-166257] generate gha docs from action yaml #265

Closed jazanne closed 1 year ago

jazanne commented 1 year ago

Summary

We can now generate information about the launchdarkly/find-code-references GitHub Action from the action.yml file which defines the Inputs.

Currently, that information lives on the docs site in git-gatsby.

I recommend that moving forward (once this is released) that the docs site links to launchdarkly/find-code-references as source of truth.

Automation

Added a pre-commit hook that makes sure that GitHub Actions README was updated

see example run in circleci

[INFO] Initializing environment for https://github.com/golangci/golangci-lint.
[INFO] Initializing environment for https://github.com/dnephin/pre-commit-golang.
github-action-docs.......................................................Failed
- hook id: github-action-docs
- files were modified by this hook

cd build/metadata/github-actions && npx action-docs -u --no-banner

Exited with code exit status 1
CircleCI received exit code 1
shortcut-integration[bot] commented 1 year ago

This pull request has been linked to Shortcut Story #166257: generate GHA docs from action.yaml.