Generate a README.md
based on step.yml
data
Description
This step can be used to generate a standard README.md based on step.yml data. The resulting readme will list the step's most important details, such as the description, a table of inputs and outputs, and links for further information.
The exact structure is defined in README.md.gotemplate
Additional step-specific content can be included from local Markdown files, such as example usage and information for contributors.
Add this step directly to your workflow in the Bitrise Workflow Editor.
You can also run this step directly with Bitrise CLI.
A workflow to generate and update README.md
:
generate-readme:
steps:
- git::https://github.com/bitrise-steplib/steps-readme-generator.git@main:
title: Generate README
Run the workflow locally by bitrise run generate-readme
, then commit the generated file.
You can also include step-specific sections in the readme. The following example uses two files stored in the step repo:
generate-readme:
steps:
- git::https://github.com/bitrise-steplib/steps-readme-generator.git@main:
title: Generate README
inputs:
- example_section: docs/examples.md
- contrib_section: docs/contributing.md
This will read the contents of docs/examples.md
and docs/contributing.md
, then include their contents in the final readme.
Inputs
Key | Description | Flags | Default |
---|---|---|---|
example_section |
Path to a Markdown file containing step-specific examples. If specified, the contents will be included in the Get started section. | ||
contrib_section |
Path to a Markdown file about step-specific information for contributors. If specified, the contents will be included in the Contributing section. |
Outputs
There are no outputs defined in this stepWe welcome pull requests and issues against this repository.
For pull requests, work on your changes in a forked repository and use the Bitrise CLI to run step tests locally.
Learn more about developing steps: