https://github.com/zerocracy/pages-action
GitHub Action that generates HTML report from a Factbase
https://github.com/zerocracy/pages-action
zerocracy
Last synced: over 1 year ago
JSON representation
GitHub Action that generates HTML report from a Factbase
- Host: GitHub
- URL: https://github.com/zerocracy/pages-action
- Owner: zerocracy
- License: mit
- Created: 2024-05-19T04:40:29.000Z (about 2 years ago)
- Default Branch: master
- Last Pushed: 2025-02-23T05:03:51.000Z (over 1 year ago)
- Last Synced: 2025-02-23T05:24:22.622Z (over 1 year ago)
- Topics: zerocracy
- Language: XSLT
- Homepage:
- Size: 535 KB
- Stars: 5
- Watchers: 4
- Forks: 2
- Open Issues: 26
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# Pages Zerocracy Action
[](http://www.rultor.com/p/zerocracy/pages-action)
[](https://github.com/zerocracy/pages-action/actions/workflows/make.yml)
[](https://hitsofcode.com/view/github/zerocracy/pages-action)
[](https://github.com/zerocracy/pages-action/blob/master/LICENSE.txt)
This GitHub Actions plugin is supposed to be used
together with [judges-action](https://github.com/zerocracy/judges-action)
(the documentation is over there). This plugin takes a Factbase file generated
by the [judges-action](https://github.com/zerocracy/judges-action) and prints
its content in YAML, XML, and HTML formats. Also, it prints a user-friendly
HTML document with a summary of project status (we call it "vitals" page).
This is how this vitals page looks for
[our team](https://zerocracy.github.io/judges-action/zerocracy-vitals.html).
The following configuration options are supported here:
```yaml
- uses: zerocracy/pages-action@0.0.43
with:
factbase: foo.fb
verbose: true
output: my-directory
columns: who,when,repository
hidden: _id,_time
options: |
github_token=${{ secrets.GITHUB_TOKEN }}
```
The following options are supported:
* `factbase` (required) is the name of the
[factbase](https://github.com/yegor256/factbase) file;
* `options` (empty by default) is a list of `k=v` options to be sent to
the [judges](https://github.com/yegor256/judges) command line tool;
* `output` (default: `pages`) is the directory where .XML, .YAML,
and .HTML files are supposed to be saved to;
* `logo` (optional) is the URL of the logo to put on the vitals HTML page;
* `columns` (optional) is a comma-separated list of columns
to print in the HTML;
* `hidden` (optional) is a comma-separated list of columns to hide;
* `today` (optional) is ISO-8601 date-time of today;
* `verbose` (default: `false`) turns on a more detailed logging.
More details are in the
[`action.yml`](https://github.com/zerocracy/pages-action/blob/master/action.yml)
file.
## How to Contribute
In order to test this action, just run (provided, you have
[GNU make](https://www.gnu.org/software/make/) installed):
```bash
make
```
Should work.