Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

ci: ensure action input and output docs are up to date #54

Merged
merged 5 commits into from
Aug 16, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 15 additions & 0 deletions .circleci/config.yml
Original file line number Diff line number Diff line change
Expand Up @@ -66,6 +66,18 @@ jobs:

<<: *build_steps

github-actions-docs:
docker:
- image: cimg/node:18.8.0
steps:
- checkout
- run: sudo apt-get update
- run: sudo apt-get install python3-pip
- run: sudo pip install pre-commit
- run: pre-commit install
- run: npm install action-docs
- run: pre-commit run -a github-action-docs

workflows:
version: 2
test:
Expand All @@ -74,3 +86,6 @@ workflows:
filters:
tags:
only: /.*/
docs:
jobs:
- github-actions-docs
9 changes: 9 additions & 0 deletions .pre-commit-config.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,15 @@ repos:
hooks:
- id: go-unit-tests

- repo: local
hooks:
- id: github-action-docs
name: github-action-docs
entry: make docs
types: [yaml]
pass_filenames: false
language: system

# Repo doesn't have right permissions?
# - repo: https://github.com/launchdarkly/pre-commit-go
# rev: v0.11.0
Expand Down
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -114,7 +114,7 @@ This action does not support monorepos or searching for flags across LaunchDarkl
| any-removed | Returns true if any flags have been removed in PR |
| removed-flags | Space-separated list of flags removed in PR |
| removed-flags-count | Number of flags removed in PR |
| any-Changed | Returns true if any flags have been changed in PR |
| any-changed | Returns true if any flags have been changed in PR |
| changed-flags | Space-separated list of flags changed in PR |
| changed-flags-count | Number of flags changed in PR |
<!-- action-docs-outputs -->
2 changes: 1 addition & 1 deletion action.yml
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@ outputs:
description: Space-separated list of flags removed in PR
removed-flags-count:
description: Number of flags removed in PR
any-Changed:
any-changed:
description: Returns true if any flags have been changed in PR
changed-flags:
description: Space-separated list of flags changed in PR
Expand Down