@readme/micro

Send your OAS files to ReadMe Micro

Usage

As a GitHub Action

name: ReadMe Micro

# Run workflow for every push to the `main` branch
on:
  push:
    branches:
      - main
jobs:
  sync:
    runs-on: ubuntu-latest
    steps:
      - name: Checkout this repo
        uses: actions/checkout@v3

      - name: GitHub Action
        uses: readmeio/readme-micro@v2.1.1
        with:
          readme-micro: "'**/*.{yaml,yml,json}' --key=\${{ secrets.README_MICRO_SECRET }}"

As an npm package

npx @readme/micro@v2.1.1 './*{yaml,yml,json}' --key=$README_MICRO_SECRET

As a Bitbucket Pipeline

image: node:18

pipelines:
  default:
    - parallel:
        - step:
            name: ReadMe Micro
            script:
              - npx @readme/micro@v2.1.1 './*{yaml,yml,json}' --key=$README_MICRO_SECRET