README.md

workflows-to-markdown

Workflows to markdown is supposed to generate a map of your event-workflows. It will show you what event causes which workflows to run.

CLI

Usage: cli [options]

Options:
  -o, --output <path>  path to an .md file that you want your documentation to be saved there. (default:
                       ".github/workflows/README.md")
  -i, --input <path>   path to a directory that contains your workflow files. (default: ".github/workflows")
  -h, --help           display help for command

Install

Note: You can use Workflows to Markdown Action if you want to automate the process of map generation.

Install with npm:

$ npm install --save-dev workflows-to-markdown

Usage

After installation you can run workflows2md on your terminal in your project's path. you can change the input and output location using CLI options;

workflows2md -i /.github/workflows -o WORKFLOWS.md

Output Example

This is a map that has been generated from AsyncAPI's website workflows.

Event-Workflow Map

pull_ request_ target	opened	edited, synchronize	reopened, ready_for_review	unlocked, unlabeled, labeled
	Automerge For Humans Automerge release bump PR Notify slack Lint PR title Welcome first time contributors	Automerge For Humans Remove ready-to-merge label Automerge release bump PR Lint PR title	Automerge For Humans Automerge release bump PR Notify slack Lint PR title	Automerge For Humans Automerge release bump PR
issues	opened	reopened	unlabeled, labeled, closed, deleted	edited
	Deploy to Netlify Notify slack Sentiment Analysis Welcome first time contributors	Deploy to Netlify Notify slack	Deploy to Netlify	Sentiment Analysis
push	master	any	**-release, next
	Bump package version in dependent repos - if Node project Release - if Node project	autoupdate	Release - if Node project
pull_ request	opened	ready_for_review, synchronize, reopened	edited
	PR testing - if Go project PR testing - if Node project Sentiment Analysis	PR testing - if Go project PR testing - if Node project	Sentiment Analysis
issue_ comment	created	edited
	Add ready-to-merge or do-not-merge label Create help comment Sentiment Analysis	Sentiment Analysis
pull_ request_ review	submitted	edited
	Automerge release bump PR Sentiment Analysis	Sentiment Analysis
schedule	At 12:00 AM
	Notify on failing automerge Manage stale issues and PRs
release	published
	Version bump - if Node.js project Announce releases in different channels
discussion	created
	Notify slack
pull_ request_ review_ comment	edited, created
	Sentiment Analysis

Workflows

Workflow	Description
Automerge For Humans	Your first comment after name parameter in workflow will appear here.
Automerge release bump PR	Your first comment after name parameter in workflow will appear here.
Notify slack	Your first comment after name parameter in workflow will appear here.
Lint PR title	Your first comment after name parameter in workflow will appear here.
Welcome first time contributors	Your first comment after name parameter in workflow will appear here.
Remove ready-to-merge label	Your first comment after name parameter in workflow will appear here.
Deploy to Netlify	Your first comment after name parameter in workflow will appear here.
Sentiment Analysis	Your first comment after name parameter in workflow will appear here.
Bump package version in dependent repos - if Node project	Your first comment after name parameter in workflow will appear here.
Release - if Node project	Your first comment after name parameter in workflow will appear here.
autoupdate	Your first comment after name parameter in workflow will appear here.
PR testing - if Go project	Your first comment after name parameter in workflow will appear here.
PR testing - if Node project	Your first comment after name parameter in workflow will appear here.
Add ready-to-merge or do-not-merge label	Your first comment after name parameter in workflow will appear here.
Create help comment	Your first comment after name parameter in workflow will appear here.
Notify on failing automerge	Your first comment after name parameter in workflow will appear here.
Manage stale issues and PRs	Your first comment after name parameter in workflow will appear here.
Version bump - if Node.js project	There is no need to substract "v" from the tag as version script handles it
Announce releases in different channels	Your first comment after name parameter in workflow will appear here.