feat(admin): identify external plugins (#1202) #1
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
| # Copyright 2023-2024 The Janus IDP Authors | |
| # | |
| # Licensed under the Apache License, Version 2.0 (the "License"); | |
| # you may not use this file except in compliance with the License. | |
| # You may obtain a copy of the License at | |
| # | |
| # http://www.apache.org/licenses/LICENSE-2.0 | |
| # | |
| # Unless required by applicable law or agreed to in writing, software | |
| # distributed under the License is distributed on an "AS IS" BASIS, | |
| # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | |
| # See the License for the specific language governing permissions and | |
| # limitations under the License. | |
| name: Publish TechDocs Site | |
| on: | |
| push: | |
| branches: | |
| - main | |
| paths: | |
| - "docs/**" | |
| - "mkdocs.yaml" | |
| concurrency: | |
| group: ${{ github.workflow }}-${{ github.ref }} | |
| cancel-in-progress: true | |
| jobs: | |
| publish-techdocs-site: | |
| name: Publish techdocs site | |
| runs-on: ubuntu-latest | |
| env: | |
| TECHDOCS_S3_BUCKET_NAME: ${{ secrets.BUCKET_NAME }} | |
| AWS_ACCESS_KEY_ID: ${{ secrets.AWS_ACCESS_KEY_ID }} | |
| AWS_SECRET_ACCESS_KEY: ${{ secrets.AWS_SECRET_ACCESS_KEY }} | |
| AWS_REGION: ${{ secrets.AWS_REGION }} | |
| ENTITY_NAMESPACE: 'default' | |
| ENTITY_KIND: 'Component' | |
| ENTITY_NAME: 'backstage-showcase' | |
| steps: | |
| - name: Checkout code | |
| uses: actions/checkout@v4 | |
| with: | |
| fetch-depth: 0 | |
| - name: Setup Node | |
| uses: actions/setup-node@v4 | |
| with: | |
| node-version-file: '.nvmrc' | |
| cache: 'yarn' | |
| - name: Setup local Turbo cache | |
| uses: dtinth/setup-github-actions-caching-for-turbo@v1 | |
| - name: Install Dependencies | |
| run: | | |
| yarn install | |
| if [[ $(git diff --name-only . | grep yarn.lock || true) ]]; then | |
| echo "After 'yarn install', workspace is dirty! The following files have changed:" | |
| echo | |
| git diff --name-only . || true | |
| exit 42 | |
| fi | |
| - name: Lint | |
| run: | | |
| yarn run prettier:check | |
| - name: Setup Python | |
| uses: actions/setup-python@v5 | |
| with: | |
| python-version: '3.9' | |
| - name: Install techdocs-cli | |
| run: sudo npm install -g @techdocs/cli | |
| - name: Install mkdocs and mkdocs plugins | |
| run: python -m pip install mkdocs-techdocs-core==1.* | |
| - name: Generate docs site | |
| run: techdocs-cli generate --no-docker --verbose | |
| - name: Publish docs site | |
| run: techdocs-cli publish --publisher-type awsS3 --storage-name $TECHDOCS_S3_BUCKET_NAME --entity $ENTITY_NAMESPACE/$ENTITY_KIND/$ENTITY_NAME |