Document comment styles and how to document APIs #468
Workflow file for this run
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
# IMPORTANT: DO NOT CHECKOUT | |
name: Make try it comment | |
on: | |
pull_request_target: | |
types: [opened, reopened] | |
concurrency: ${{ github.workflow }}-${{ github.ref }} | |
# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages | |
permissions: | |
pull-requests: write | |
jobs: | |
# Create PR | |
pr_created: | |
name: Provide try it comments | |
runs-on: ubuntu-latest | |
steps: | |
- uses: actions/github-script@v5 | |
with: | |
github-token: ${{secrets.GITHUB_TOKEN}} | |
script: | | |
const prNumber = ${{ github.event.pull_request.number }}; | |
github.rest.issues.createComment({ | |
issue_number: context.issue.number, | |
owner: context.repo.owner, | |
repo: context.repo.repo, | |
body: [ | |
`Changes in this PR will be published to the following url to try(check status of TypeSpec Pull Request Try It pipeline for publish status):`, | |
`Playground: https://cadlplayground.z22.web.core.windows.net/prs/${prNumber}/`, | |
"", | |
`Website: https://cadlwebsite.z1.web.core.windows.net/prs/${prNumber}/`, | |
].join("\n") | |
}) |