doc: readme

.github/workflows/CI.yml

@@ -1,4 +1,4 @@
-name: CI
+name: '🌞 CI'
 
 on:
   workflow_dispatch:  

README.md

@@ -1,105 +1,39 @@
-<p align="center">
-  <a href="https://github.com/actions/typescript-action/actions"><img alt="typescript-action status" src="https://github.com/actions/typescript-action/workflows/build-test/badge.svg"></a>
-</p>
-
-# Create a JavaScript Action using TypeScript
-
-Use this template to bootstrap the creation of a TypeScript action.:rocket:
-
-This template includes compilation support, tests, a validation workflow, publishing, and versioning guidance.  
-
-If you are new, there's also a simpler introduction.  See the [Hello World JavaScript Action](https://github.com/actions/hello-world-javascript-action)
-
-## Create an action from this template
-
-Click the `Use this Template` and provide the new repo details for your action
-
-## Code in Main
-
-> First, you'll need to have a reasonably modern version of `node` handy. This won't work with versions older than 9, for instance.
-
-Install the dependencies  
-```bash
-$ npm install
-```
-
-Build the typescript and package it for distribution
-```bash
-$ npm run build && npm run package
-```
-
-Run the tests :heavy_check_mark:  
-```bash
-$ npm test
-
- PASS  ./index.test.js
-  ✓ throws invalid number (3ms)
-  ✓ wait 500 ms (504ms)
-  ✓ test runs (95ms)
-
-...
-```
-
-## Change action.yml
-
-The action.yml defines the inputs and output for your action.
-
-Update the action.yml with your name, description, inputs and outputs for your action.
-
-See the [documentation](https://help.github.com/en/articles/metadata-syntax-for-github-actions)
-
-## Change the Code
-
-Most toolkit and CI/CD operations involve async operations so the action is run in an async function.
-
-```javascript
-import * as core from '@actions/core';
-...
-
-async function run() {
-  try { 
-      ...
-  } 
-  catch (error) {
-    core.setFailed(error.message);
-  }
-}
-
-run()
+[![CI](https://github.com/maxisam/create-summary-check-status/actions/workflows/CI.yml/badge.svg)](https://github.com/maxisam/create-summary-check-status/actions/workflows/CI.yml)
+
+# Create Summary Check Status
+
+This is a simple action to handle situation if you have multiple jobs in a workflow and some of them might be skipped sometime
+
+However, you want to use this workflow to check for PRs.
+
+If you have this issue, this action provides a input called jobResults
+
+It takes all the result from previous jobs
+
+```yml
+check:
+  runs-on: ubuntu-latest
+  # the jobs need to pass
+  needs: [job1, job2]
+  # use always() so if previous jobs fail, this job will still run
+  if: always()
+  steps:
+    - uses: maxisam/create-summary-check-status@v1
+      with:
+        jobResults: |
+          ${{ needs.job1.result }}
+          ${{ needs.job2.result }}
+        authToken: ${{secrets.GITHUB_TOKEN}}
+        # name showing on the check
+        checkName: CI PASSED
+        # if any result in job1,job2 is [failure,cacelled], the check will be failure, otherwise the check will be success
+        failureState: |
+          failure
+          cancelled
+        # for PR or Push
+        sha: ${{ github.event.pull_request.head.sha || github.sha }}
 ```
 
-See the [toolkit documentation](https://github.com/actions/toolkit/blob/master/README.md#packages) for the various packages.
-
-## Publish to a distribution branch
-
-Actions are run from GitHub repos so we will checkin the packed dist folder. 
-
-Then run [ncc](https://github.com/zeit/ncc) and push the results:
-```bash
-$ npm run package
-$ git add dist
-$ git commit -a -m "prod dependencies"
-$ git push origin releases/v1
-```
-
-Note: We recommend using the `--license` option for ncc, which will create a license file for all of the production node modules used in your project.
-
-Your action is now published! :rocket: 
-
-See the [versioning documentation](https://github.com/actions/toolkit/blob/master/docs/action-versioning.md)
-
-## Validate
-
-You can now validate the action by referencing `./` in a workflow in your repo (see [test.yml](.github/workflows/test.yml))
-
-```yaml
-uses: ./
-with:
-  milliseconds: 1000
-```
-
-See the [actions tab](https://github.com/actions/typescript-action/actions) for runs of this action! :rocket:
-
-## Usage:
+Of course, you can use this action to assign any state to a commit
 
-After testing you can [create a v1 tag](https://github.com/actions/toolkit/blob/master/docs/action-versioning.md) to reference the stable and latest V1 action
+if you just use `state` input, it will ignore `jobResults` and `failureState`

action.yml

@@ -1,6 +1,9 @@
 name: 'Create Summary Check Status'
 description: 'Provide a final check for multiple checks'
 author: 'maxisam'
+branding:
+  icon: check
+  color: yellow
 inputs:
   jobResults:
     required: true