commit 9df1d2b1cafdd9a52b262801ea3ac1a6b8de435a
parent 9b050c870fdab83347e7c3460087a5a1859338ed
Author: MTRNord <mtrnord1@gmail.com>
Date: Wed, 12 Apr 2023 13:24:20 +0200
Update README
Diffstat:
| M | README.md | | | 128 | +++++++++++++++++-------------------------------------------------------------- |
1 file changed, 27 insertions(+), 101 deletions(-)
diff --git a/README.md b/README.md
@@ -1,109 +1,35 @@
-<p align="center">
- <a href="https://github.com/MTRNord/zola-check-manager/actions"><img alt="typescript-action status" src="https://github.com/MTRNord/zola-check-manager/workflows/build-test/badge.svg"></a>
-</p>
+# Zola Check Manager
-# Create a JavaScript Action using TypeScript
+[](https://actions-badge.atrox.dev/MTRNord/zola-check-manager/goto)
+
-Use this template to bootstrap the creation of a TypeScript action.:rocket:
+A Github action to track the status of a `zola check` using check runs.
-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()
-```
-
-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))
+## Usage
```yaml
-uses: ./
-with:
- milliseconds: 1000
+name: Zola Check
+
+on:
+ push:
+ branches:
+ - main
+ pull_request:
+ branches:
+ - main
+
+jobs:
+ zola-check:
+ runs-on: ubuntu-latest
+ steps:
+ - uses: actions/checkout@v2
+ - uses: MTRNord/zola-check-manager@v1
+ with:
+ github-token: ${{ secrets.GITHUB_TOKEN }}
```
-See the [actions tab](https://github.com/actions/typescript-action/actions) for runs of this action! :rocket:
-
-## Usage
+## Inputs
-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
+* `working_directory`: The folder where the `zola check` should be executed. Default: `.`
+* `repo-token`: The token to use to authenticate with Github. Default: `${{ secrets.GITHUB_TOKEN }}`. This requires the `checks:write` permission.
+* `conclusion_level`: The conclusion level to use. Default: `failure`. Can be `action_required`, `failure`, `neutral`, `success`. Default: `action_required`
