create-readme-file-pull-request-action

api.video is the video infrastructure for product builders. Lightning fast video APIs for integrating, scaling, and managing on-demand & low latency live streaming features in your app.

Table of contents

• Table of contents
• Project description
• Getting started
  • Usage
• Documentation
  • <documentation_excluded>
  • <documentation_only>

Project description

This GitHub action is used in our SDKs repositories to apply some modifications to the README.md file in order to make it more readable on our documentation website. It then creates a pull request in the given repository with the updated markdown file.

Getting started

Usage

      - name: Apply changes to the README file
        uses: apivideo/api.video-create-readme-file-pull-request-action@main
        with: 
          source-file-path: "README.md"
          destination-repository: apivideo/api.video-api-client-generator
          destination-path: templates/documentation/sdks/vod
          destination-filename: apivideo-typescript-uploader.md
          pat: "${{ secrets.PAT }}"

Documentation

Here are the tags that can be used in the README.md file to apply some modifications:

<documentation_excluded>

Use this tag to exclude a part of the README.md file from the documentation website.

Example:

# My title

<!--<documentation_excluded>-->
This part will not be displayed on the documentation website.
<!--</documentation_excluded>-->

blabla

<documentation_only>

Use this tag to display a part of the README.md file only on the documentation website.

Example:

# My title

<!--<documentation_only>
This part will be displayed only on the documentation website.
</documentation_only>-->

blabla