DEPRECATED!! Instead of using this repository, you should put the following into your README which is supported directly by GitHub:
[](https://github.com/{owner}/{repo}/actions)
This is a small AWS lambda that renders a README badge based on the status of your Github Actions workflow. You can add the badge to your README by including:
[](https://xxx.execute-api.us-west-2.amazonaws.com/production/results/{owner}/{repo})
where {owner} and {repo} are replaced by the github username and the repository name, respectively. For example, this repository would use:
https://xxx.execute-api.us-west-2.amazonaws.com/production/badge/CultureHQ/github-actions-badge
Optionally a branch can be specified using the branch query parameter.
Without this parameter, it will use the master branch.
https://xxx.execute-api.us-west-2.amazonaws.com/production/badge/{owner}/{repo}?branch={branch}
The badge variants look like:
You can pass additional options to the badge through the image URL that will be forwarded on to shields.io (the source for the images). The options are documented on their page.
For instance, if you wanted to change the style to flat-square, you could pass it as a query param as in:
[](https://xxx.execute-api.us-west-2.amazonaws.com/production/results/{owner}/{repo})
In order for the lambda to get status from Github for private repos, you have to create
a token with repo access and set that in .env.yml.
cp .env.yml.example .env.ymlTo develop locally, install dependencies with yarn. Then you can run yarn start at the root of the repository to start a local server. To deploy to your AWS environment, run yarn deploy.
Bug reports and pull requests are welcome on GitHub at https://github.com/CultureHQ/github-actions-badge.
The code is available as open source under the terms of the MIT License.