github-action-wait-commit-status/README.yaml at main · cloudposse/github-action-wait-commit-status · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
#
# This is the canonical configuration for the `README.md`
# Run `make readme` to rebuild the `README.md`
#

# Name of this project
name: github-action-wait-commit-status

# Tags of this project
tags:
  - github-action

# Logo for this project
#logo: docs/logo.png

# License of this project
license: "APACHE2"

# Canonical GitHub repo
github_repo: cloudposse/github-action-wait-commit-status

# Badges to display
badges:
  - name: Latest Release
    image: https://img.shields.io/github/release/cloudposse/github-action-wait-commit-status.svg?style=for-the-badge
    url: https://github.com/cloudposse/github-action-wait-commit-status/releases/latest
  - name: Last Updated
    image: https://img.shields.io/github/last-commit/cloudposse/github-action-wait-commit-status.svg?style=for-the-badge
    url: https://github.com/cloudposse/github-action-wait-commit-status/commits
  - name: Slack Community
    image: https://slack.cloudposse.com/for-the-badge.svg
    url: https://cloudposse.com/slack

# List any related terraform modules that this module may be used with or that this module depends on.
related: []

# Short description of this project
description: Wait for commit status

introduction: |-
  Checks GitHub API for a given commit and look the commit status.

references:
  - name: "github-actions-workflows"
    description: "Reusable workflows for different types of projects"
    url: "https://github.com/cloudposse/github-actions-workflows"
  - name: "github-action-deploy-argocd"
    description: "Deploy on Kubernetes with ArgoCD"
    url: "https://github.com/cloudposse/github-action-deploy-argocd"

# How to use this project
usage: |-
  ```yaml
    name: Pull Request
    on:
      pull_request:
        branches: [ 'main' ]
        types: [opened, synchronize, reopened, closed, labeled, unlabeled]

    jobs:
      context:
        runs-on: ubuntu-latest
        steps:
          - name: Wait commit status
            uses: cloudposse/github-action-wait-commit-status@main
            with:
              repository: ${{ github.repository }}
              sha: ${{ github.sha }}
              status: continuous-delivery/example-app
              lookup: "success"
              token: ${{ github.token }}
              check-timeout: 120
              check-retry-count: 5
              check-retry-interval: 20
  ```

include: []
contributors: []