-
Notifications
You must be signed in to change notification settings - Fork 26
feat(openapi): add OpenAPI specification generation #905
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.
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
oleksandr-nc
wants to merge
1
commit into
main
Choose a base branch
from
enh/openapi-spec
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,199 @@ | ||
| # This workflow is provided via the organization template repository | ||
| # | ||
| # https://github.com/nextcloud/.github | ||
| # https://docs.github.com/en/actions/learn-github-actions/sharing-workflows-with-your-organization | ||
| # | ||
| # SPDX-FileCopyrightText: 2021-2024 Nextcloud GmbH and Nextcloud contributors | ||
| # SPDX-License-Identifier: MIT | ||
|
|
||
| name: OpenAPI Command | ||
| on: | ||
| issue_comment: | ||
| types: [created] | ||
|
|
||
| permissions: | ||
| contents: read | ||
|
|
||
| jobs: | ||
| init: | ||
| runs-on: ubuntu-latest | ||
|
|
||
| # On pull requests and if the comment starts with `/openapi` | ||
| if: github.event.issue.pull_request != '' && startsWith(github.event.comment.body, '/openapi') | ||
|
|
||
| outputs: | ||
| git_path: ${{ steps.git-path.outputs.path }} | ||
| arg1: ${{ steps.command.outputs.arg1 }} | ||
| arg2: ${{ steps.command.outputs.arg2 }} | ||
| head_ref: ${{ steps.comment-branch.outputs.head_ref }} | ||
| base_ref: ${{ steps.comment-branch.outputs.base_ref }} | ||
|
|
||
| steps: | ||
| - name: Get repository from pull request comment | ||
| uses: actions/github-script@3a2844b7e9c422d3c10d287c895573f7108da1b3 # v9.0.0 | ||
| id: get-repository | ||
| with: | ||
| github-token: ${{secrets.GITHUB_TOKEN}} | ||
| script: | | ||
| const pull = await github.rest.pulls.get({ | ||
| owner: context.repo.owner, | ||
| repo: context.repo.repo, | ||
| pull_number: context.issue.number | ||
| }); | ||
|
|
||
| const repositoryName = pull.data.head?.repo?.full_name | ||
| console.log(repositoryName) | ||
| return repositoryName | ||
|
|
||
| - name: Disabled on forks | ||
| if: ${{ fromJSON(steps.get-repository.outputs.result) != github.repository }} | ||
| run: | | ||
| echo 'Can not execute /openapi on forks' | ||
| exit 1 | ||
|
|
||
| - name: Check actor permission | ||
| uses: skjnldsv/check-actor-permission@69e92a3c4711150929bca9fcf34448c5bf5526e7 # v3.0 | ||
| with: | ||
| require: write | ||
|
|
||
| - name: Add reaction on start | ||
| uses: peter-evans/create-or-update-comment@e8674b075228eee787fea43ef493e45ece1004c9 # v5.0.0 | ||
| with: | ||
| token: ${{ secrets.COMMAND_BOT_PAT }} | ||
| repository: ${{ github.event.repository.full_name }} | ||
| comment-id: ${{ github.event.comment.id }} | ||
| reactions: '+1' | ||
|
|
||
| - name: Parse command | ||
| uses: skjnldsv/parse-command-comment@5c955203c52424151e6d0e58fb9de8a9f6a605a1 # v3.1 | ||
| id: command | ||
|
|
||
| # Init path depending on which command is run | ||
| - name: Init path | ||
| id: git-path | ||
| run: | | ||
| if ${{ startsWith(steps.command.outputs.arg1, '/') }}; then | ||
| echo "path=${{steps.command.outputs.arg1}}" >> $GITHUB_OUTPUT | ||
| else | ||
| echo "path=${{steps.command.outputs.arg2}}" >> $GITHUB_OUTPUT | ||
| fi | ||
|
|
||
| - name: Init branch | ||
| uses: xt0rted/pull-request-comment-branch@e8b8daa837e8ea7331c0003c9c316a64c6d8b0b1 # v3.0.0 | ||
| id: comment-branch | ||
|
|
||
| - name: Add reaction on failure | ||
| uses: peter-evans/create-or-update-comment@e8674b075228eee787fea43ef493e45ece1004c9 # v5.0.0 | ||
| if: failure() | ||
| with: | ||
| token: ${{ secrets.COMMAND_BOT_PAT }} | ||
| repository: ${{ github.event.repository.full_name }} | ||
| comment-id: ${{ github.event.comment.id }} | ||
| reactions: '-1' | ||
|
|
||
| process: | ||
| runs-on: ubuntu-latest | ||
| needs: init | ||
|
|
||
| steps: | ||
| - name: Restore cached git repository | ||
| uses: actions/cache@27d5ce7f107fe9357f9df03efb73ab90386fccae # v5.0.5 | ||
| with: | ||
| path: .git | ||
| key: git-repo | ||
|
|
||
| - name: Checkout ${{ needs.init.outputs.head_ref }} | ||
| uses: actions/checkout@df4cb1c069e1874edd31b4311f1884172cec0e10 # v6.0.3 | ||
| with: | ||
| # Needed to allow force push later | ||
| persist-credentials: true | ||
| token: ${{ secrets.COMMAND_BOT_PAT }} | ||
| fetch-depth: 0 | ||
| ref: ${{ needs.init.outputs.head_ref }} | ||
|
|
||
| - name: Setup git | ||
| run: | | ||
| git config --local user.email 'nextcloud-command@users.noreply.github.com' | ||
| git config --local user.name 'nextcloud-command' | ||
|
|
||
| - name: Check Typescript OpenApi types | ||
| id: check_typescript_openapi | ||
| uses: andstor/file-existence-action@558493d6c74bf472d87c84eab196434afc2fa029 # v3.1.0 | ||
| with: | ||
| files: "src/types/openapi/openapi*.ts" | ||
|
|
||
| - name: Read package.json node and npm engines version | ||
| if: steps.check_typescript_openapi.outputs.files_exists == 'true' | ||
| uses: skjnldsv/read-package-engines-version-actions@06d6baf7d8f41934ab630e97d9e6c0bc9c9ac5e4 # v3 | ||
| id: node_versions | ||
| # Continue if no package.json | ||
| continue-on-error: true | ||
| with: | ||
| fallbackNode: '^24' | ||
| fallbackNpm: '^11.3' | ||
|
|
||
| - name: Set up node ${{ steps.node_versions.outputs.nodeVersion }} | ||
| if: ${{ steps.node_versions.outputs.nodeVersion }} | ||
| uses: actions/setup-node@48b55a011bda9f5d6aeb4c2d9c7362e8dae4041e # v6.4.0 | ||
| with: | ||
| node-version: ${{ steps.node_versions.outputs.nodeVersion }} | ||
|
|
||
| - name: Set up npm ${{ steps.node_versions.outputs.npmVersion }} | ||
| if: ${{ steps.node_versions.outputs.nodeVersion }} | ||
| run: npm i -g 'npm@${{ steps.node_versions.outputs.npmVersion }}' | ||
|
|
||
| - name: Rebase to ${{ needs.init.outputs.base_ref }} | ||
| if: ${{ contains(needs.init.outputs.arg1, 'rebase') }} | ||
| run: | | ||
| git fetch origin '${{ needs.init.outputs.base_ref }}:${{ needs.init.outputs.base_ref }}' | ||
| git rebase 'origin/${{ needs.init.outputs.base_ref }}' | ||
|
|
||
| - name: Install dependencies | ||
| env: | ||
| CYPRESS_INSTALL_BINARY: 0 | ||
| PUPPETEER_SKIP_DOWNLOAD: true | ||
| run: | | ||
| npm ci | ||
|
|
||
| - name: Set up dependencies | ||
| run: composer i | ||
|
|
||
| - name: Regenerate OpenAPI | ||
| run: composer run openapi | ||
|
|
||
| - name: Commit default | ||
| if: ${{ !contains(needs.init.outputs.arg1, 'fixup') && !contains(needs.init.outputs.arg1, 'amend') }} | ||
| run: | | ||
| git add '${{ github.workspace }}${{ needs.init.outputs.git_path }}' | ||
| git commit --signoff -m 'fix(openapi): Regenerate OpenAPI assets' | ||
|
|
||
| - name: Commit fixup | ||
| if: ${{ contains(needs.init.outputs.arg1, 'fixup') }} | ||
| run: | | ||
| git add '${{ github.workspace }}${{ needs.init.outputs.git_path }}' | ||
| git commit --fixup=HEAD --signoff | ||
|
|
||
| - name: Commit amend | ||
| if: ${{ contains(needs.init.outputs.arg1, 'amend') }} | ||
| run: | | ||
| git add '${{ github.workspace }}${{ needs.init.outputs.git_path }}' | ||
| git commit --amend --no-edit --signoff | ||
| # Remove any [skip ci] from the amended commit | ||
| git commit --amend -m "$(git log -1 --format='%B' | sed '/\[skip ci\]/d')" | ||
|
|
||
| - name: Push normally | ||
| if: ${{ !contains(needs.init.outputs.arg1, 'rebase') && !contains(needs.init.outputs.arg1, 'amend') }} | ||
| run: git push origin '${{ needs.init.outputs.head_ref }}' | ||
|
|
||
| - name: Force push | ||
| if: ${{ contains(needs.init.outputs.arg1, 'rebase') || contains(needs.init.outputs.arg1, 'amend') }} | ||
| run: git push --force-with-lease origin '${{ needs.init.outputs.head_ref }}' | ||
|
|
||
| - name: Add reaction on failure | ||
| uses: peter-evans/create-or-update-comment@e8674b075228eee787fea43ef493e45ece1004c9 # v5.0.0 | ||
| if: failure() | ||
| with: | ||
| token: ${{ secrets.COMMAND_BOT_PAT }} | ||
| repository: ${{ github.event.repository.full_name }} | ||
| comment-id: ${{ github.event.comment.id }} | ||
| reactions: '-1' | ||
This file contains hidden or 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,96 @@ | ||
| # This workflow is provided via the organization template repository | ||
| # | ||
| # https://github.com/nextcloud/.github | ||
| # https://docs.github.com/en/actions/learn-github-actions/sharing-workflows-with-your-organization | ||
| # | ||
| # SPDX-FileCopyrightText: 2024 Nextcloud GmbH and Nextcloud contributors | ||
| # SPDX-FileCopyrightText: 2024 Arthur Schiwon <blizzz@arthur-schiwon.de> | ||
| # SPDX-License-Identifier: MIT | ||
|
|
||
| name: OpenAPI | ||
|
|
||
| on: pull_request | ||
|
|
||
| permissions: | ||
| contents: read | ||
|
|
||
| concurrency: | ||
| group: openapi-${{ github.head_ref || github.run_id }} | ||
| cancel-in-progress: true | ||
|
|
||
| jobs: | ||
| openapi: | ||
| runs-on: ubuntu-latest | ||
|
|
||
| if: ${{ github.repository_owner != 'nextcloud-gmbh' }} | ||
|
|
||
| steps: | ||
| - name: Checkout | ||
| uses: actions/checkout@df4cb1c069e1874edd31b4311f1884172cec0e10 # v6.0.3 | ||
| with: | ||
| persist-credentials: false | ||
|
|
||
| - name: Get php version | ||
| id: php_versions | ||
| uses: icewind1991/nextcloud-version-matrix@8a7bac6300b2f0f3100088b297995a229558ddba # v1.3.2 | ||
|
|
||
| - name: Set up php | ||
| uses: shivammathur/setup-php@7c071dfe9dc99bdf297fa79cb49ea005b9fcadbc # 2.37.1 | ||
| with: | ||
| php-version: ${{ steps.php_versions.outputs.php-available }} | ||
| extensions: xml | ||
| coverage: none | ||
| ini-file: development | ||
| env: | ||
| GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} | ||
|
|
||
| - name: Check Typescript OpenApi types | ||
| id: check_typescript_openapi | ||
| uses: andstor/file-existence-action@558493d6c74bf472d87c84eab196434afc2fa029 # v3.1.0 | ||
| with: | ||
| files: "src/types/openapi/openapi*.ts" | ||
|
|
||
| - name: Read package.json node and npm engines version | ||
| if: steps.check_typescript_openapi.outputs.files_exists == 'true' | ||
| uses: skjnldsv/read-package-engines-version-actions@06d6baf7d8f41934ab630e97d9e6c0bc9c9ac5e4 # v3 | ||
| id: node_versions | ||
| # Continue if no package.json | ||
| continue-on-error: true | ||
| with: | ||
| fallbackNode: '^24' | ||
| fallbackNpm: '^11.3' | ||
|
|
||
| - name: Set up node ${{ steps.node_versions.outputs.nodeVersion }} | ||
| if: ${{ steps.node_versions.outputs.nodeVersion }} | ||
| uses: actions/setup-node@48b55a011bda9f5d6aeb4c2d9c7362e8dae4041e # v6.4.0 | ||
| with: | ||
| node-version: ${{ steps.node_versions.outputs.nodeVersion }} | ||
|
|
||
| - name: Set up npm ${{ steps.node_versions.outputs.npmVersion }} | ||
| if: ${{ steps.node_versions.outputs.nodeVersion }} | ||
| run: npm i -g 'npm@${{ steps.node_versions.outputs.npmVersion }}' | ||
|
|
||
| - name: Install dependencies | ||
| if: ${{ steps.node_versions.outputs.nodeVersion }} | ||
| env: | ||
| CYPRESS_INSTALL_BINARY: 0 | ||
| PUPPETEER_SKIP_DOWNLOAD: true | ||
| run: | | ||
| npm ci | ||
|
|
||
| - name: Set up dependencies | ||
| run: composer i | ||
|
|
||
| - name: Regenerate OpenAPI | ||
| run: composer run openapi | ||
|
|
||
| - name: Check openapi*.json and typescript changes | ||
| run: | | ||
| bash -c "[[ ! \"`git status --porcelain `\" ]] || (echo 'Please run \"composer run openapi\" and commit the openapi*.json files and (if applicable) src/types/openapi/openapi*.ts, see the section \"Show changes on failure\" for details' && exit 1)" | ||
|
|
||
| - name: Show changes on failure | ||
| if: failure() | ||
| run: | | ||
| git status | ||
| git --no-pager diff | ||
| exit 1 # make it red to grab attention |
This file contains hidden or 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
This file contains hidden or 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
This file contains hidden or 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
This file contains hidden or 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
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.