Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/LinuxSuRen/yaml-readme
A helper to generate the READE file automatically from YAML-based metadata files.
https://github.com/LinuxSuRen/yaml-readme
github-actions readme yaml
Last synced: about 2 months ago
JSON representation
A helper to generate the READE file automatically from YAML-based metadata files.
- Host: GitHub
- URL: https://github.com/LinuxSuRen/yaml-readme
- Owner: LinuxSuRen
- License: mit
- Created: 2022-06-01T02:30:47.000Z (over 2 years ago)
- Default Branch: master
- Last Pushed: 2024-05-23T02:19:16.000Z (4 months ago)
- Last Synced: 2024-06-29T11:22:38.823Z (3 months ago)
- Topics: github-actions, readme, yaml
- Language: Go
- Homepage:
- Size: 410 KB
- Stars: 16
- Watchers: 3
- Forks: 10
- Open Issues: 9
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://codecov.io/gh/LinuxSuRen/yaml-readme)
[](https://marketplace.visualstudio.com/items?itemName=linuxsuren.yaml-readme)
A helper to generate the READE file automatically.
## Get started
Install it via [hd](https://github.com/LinuxSuRen/http-downloader/):
```shell
hd i yaml-readme
```
## Usage
```shell
# yaml-readme -h
Usage:
yaml-readme [flags]
Flags:
-h, --help help for yaml-readme
-p, --pattern string The glob pattern with Golang spec to find files (default "items/*.yaml")
-t, --template string The template file which should follow Golang template spec (default "README.tpl")
```
### Available variables:
| Name | Usage |
|--------------|-------------------------------------------------------------------------------------------------|
| `filename` | The filename of a particular item file. For example, `items/good.yaml`, the filename is `good`. |
| `parentname` | The parent directory name. For example, `items/good.yaml`, the parent name is `items`. |
| `fullpath` | The related file path of each items. |
### Available functions
| Name | Usage | Description |
|---------------------|----------------------------------------------------|-------------------------------------------------------------------------|
| `printHelp` | `{{printHelp 'hd'}}` | Print the help text of a command |
| `printToc` | `{{printToc}}` | Print the [TOC](https://en.wikipedia.org/wiki/TOC) of the template file |
| `printContributors` | `{{printContributors "linuxsuren" "yaml-readme"}}` | Print all the contributors of an repository |
| `printStarHistory` | `{{printStarHistory "linuxsuren" "yaml-readme"}}` | Print the star history of an repository |
| `printVisitorCount` | `{{printVisitorCount "repo-id"}}` | Print the visitor count chart of an repository |
| `printPages` | `{{printPages "linuxsuren"}}` | Print all the repositories that pages enabled |
| `render` | `{{render true}}` | Make the value be readable, turn `true` to `:white_check_mark:` |
| `gh` | `{{gh "linuxsuren" true}}` | Render a GitHub user to be a link |
| `ghs` | `{{ghs "linuxsuren, linuxsuren" ","}}` | Render multiple GitHub users to be links |
| `link` | `{{link "text" "link"}}` | Print a Markdown style link |
| `linkOrEmpty` | `{{linkOrEmpty "text" "link"}}` | Print a Markdown style link or empty if text is none |
| `ghEmoji` | `{{ghEmoji "linuxsuren"}}` | Print a Markdown style link with Emoji |
> Want to use more powerful functions? Please feel free to see also [Sprig](http://masterminds.github.io/sprig/).
> You could use all functions from both built-in and Sprig.
### Ignore particular items
In case you want to ignore some particular items, you can put a key `ignore` with value `true`. Let's see the following sample:
```yaml
name: rick
ignore: true
```
## Use in GitHub actions
You could copy the following sample YAML, and change some variables according to your needs.
```yaml
name: generator
on:
push:
branches: [ master ]
workflow_dispatch:
jobs:
build:
runs-on: ubuntu-latest
if: "!contains(github.event.head_commit.message, 'ci skip')"
steps:
- uses: actions/checkout@v3
- name: Update readme
uses: linuxsuren/[email protected]
env:
GH_TOKEN: ${{ secrets.GH_SECRETS }}
with:
pattern: 'config/*/*.yml'
username: linuxsuren
org: linuxsuren
repo: hd-home
```
### Samples
Below is a simple template sample:
```gotemplate
The total number of tools is: {{len .}}
| Name | Latest | Download |
|---|---|---|
{{- range $val := .}}
| {{$val.name}} | {{$val.latest}} | {{$val.download}} |
{{- end}}
```
Below is a grouped data sample:
```gotemplate
{{- range $key, $val := .}}
Year: {{$key}}
| Name | Age |
|---|---|
{{- range $item := $val}}
| {{$item.name}} | {{$item.age}} |
{{- end}}
{{end}}
```
You could use the following command to render it:
```shell
yaml-readme --group-by year
```
Assume there is a complex YAML like this:
```yaml
metadata:
annotations:
group/key: 'a value'
```
then you can use the following template:
```gotemplate
{{index $item.metadata.annotations "group/key"}}
```