@readme/micro
v2.6.1
Published
Send your OAS files to ReadMe Micro
Downloads
40
Maintainers
Keywords
Readme
@readme/micro
Send your OAS files to ReadMe Micro
Usage
As a GitHub Action
name: ReadMe Micro
# Run workflow to sync OpenAPI files for every push to the `main` branch
on:
push:
branches: [main]
pull_request:
branches: [main]
jobs:
sync:
runs-on: ubuntu-latest
steps:
- name: Checkout this repo
uses: actions/checkout@v3
# Run GitHub Action to sync all OpenAPI files in the repo
- name: GitHub Action
uses: readmeio/[email protected]
with:
readme-micro: "'**/*.{yaml,yml,json}' --key=\${{ secrets.README_MICRO_SECRET }}"
As an npm package
npx @readme/[email protected] './*{yaml,yml,json}' --key=$README_MICRO_SECRET
As a Bitbucket Pipeline
definitions:
steps:
- step: &readme-micro
name: ReadMe Micro
image: node:18
script:
- npx @readme/[email protected] '**/*.{yaml,yml,json}' --key=$README_MICRO_SECRET
# Run Pipeline to sync OpenAPI files for every push to the `main` branch
pipelines:
branches:
main:
- step: *readme-micro
pull-requests:
'**':
- step: *readme-micro