Skip to content

docs: oops v10 is out now #2063

docs: oops v10 is out now

docs: oops v10 is out now #2063

Workflow file for this run

name: Sync `documentation` directory to ReadMe
# Run workflow for every push
on:
push:
branches:
- main
jobs:
sync:
runs-on: ubuntu-latest
steps:
- name: Checkout this repo
uses: actions/checkout@v4
- name: Install and build rdme deps
run: npm ci && npm run build
# Let's dynamically update our docs with the latest version of rdme!
# Note that these next three steps are not required
# in order to sync your docs to ReadMe.
# First, we run a script that sets a few outputs:
# our package version and our Node.js version.
- name: Retrieve version values
id: rdme-version
run: ./bin/set-version-output.js
# Next, we use this output to do a few find/replaces!
- name: Find and replace Node.js version placeholders
uses: jacobtomlinson/gha-find-replace@v3
with:
find: 'NODE_VERSION'
replace: ${{ steps.rdme-version.outputs.NODE_VERSION }}
regex: false
include: documentation/*
- name: Find and replace `rdme` version placeholders
uses: jacobtomlinson/gha-find-replace@v3
with:
find: 'RDME_VERSION'
replace: ${{ steps.rdme-version.outputs.RDME_VERSION }}
regex: false
include: documentation/*
- name: Sync docs to ReadMe
uses: readmeio/rdme@v9
with:
rdme: docs ./documentation --key=${{ secrets.README_DEVELOPERS_API_KEY }} --version=${{ vars.README_DEVELOPERS_MAIN_VERSION }}