Skip to content

chore: update api reference docs on each core release #11305

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
NathanWalker wants to merge 1 commit into
base: main
Choose a base branch
from
Open

chore: update api reference docs on each core release #11305

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
45 changes: 45 additions & 0 deletions .github/workflows/notify_docs_core_release.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
name: 'notify docs on core release'

# When a @nativescript/core release tag is pushed (Nx releaseTag pattern
# "{version}-core", e.g. "9.0.21-core"), notify NativeScript/docs so it
# regenerates the API reference for the new version.
#
# Requires the DOCS_DISPATCH_TOKEN secret: a fine-grained PAT (or classic PAT
# with repo scope) that has contents read/write on NativeScript/docs.
#
# Note: tags pushed by other workflows using the default GITHUB_TOKEN do not
# trigger this workflow (GitHub suppresses recursive workflow runs). Tags
# pushed by maintainers or with a PAT/deploy key trigger it normally.

on:
push:
tags:
- '[0-9]*-core'

permissions:
contents: read

jobs:
dispatch:
runs-on: ubuntu-latest
steps:
- name: Extract version from tag
id: version
run: |
TAG="${GITHUB_REF_NAME}"
VERSION="${TAG%-core}"
echo "version=$VERSION" >> "$GITHUB_OUTPUT"
# skip prereleases (e.g. 9.1.0-alpha.11-core)
if [[ "$VERSION" == *-* ]]; then
echo "prerelease=true" >> "$GITHUB_OUTPUT"
else
echo "prerelease=false" >> "$GITHUB_OUTPUT"
fi
- name: Trigger docs API regeneration
if: steps.version.outputs.prerelease == 'false'
env:
GH_TOKEN: ${{ secrets.DOCS_DISPATCH_TOKEN }}
run: |
gh api repos/NativeScript/docs/dispatches \
-f event_type=core-release \
-f 'client_payload[version]=${{ steps.version.outputs.version }}'
Loading