From 9a7ff1f17074e69de74b77925a67a36b09393cce Mon Sep 17 00:00:00 2001 From: Victor Valentim Date: Wed, 30 Oct 2024 13:56:12 -0300 Subject: [PATCH] Update Documentation --- .github/workflows/deploy_website.yml | 10 +++------- .github/workflows/pr_preview.yml | 21 +++------------------ 2 files changed, 6 insertions(+), 25 deletions(-) diff --git a/.github/workflows/deploy_website.yml b/.github/workflows/deploy_website.yml index 85514f1..885f48d 100644 --- a/.github/workflows/deploy_website.yml +++ b/.github/workflows/deploy_website.yml @@ -1,10 +1,8 @@ -name: Deploy Website - +name: deploy_website on: push: branches: - main - permissions: contents: write @@ -12,7 +10,6 @@ jobs: deploy: concurrency: ci-${{ github.ref }} runs-on: ubuntu-latest - steps: - name: Checkout sources uses: actions/checkout@v4 @@ -20,11 +17,10 @@ jobs: - name: Setup Python uses: actions/setup-python@v5 with: - python-version: '3.x' + python-version: 3.x - name: Install dependencies - run: | - pip install mkdocs-dracula-theme mkdocs-static-i18n[material] mkdocs-material + run: pip install mkdocs-dracula-theme mkdocs-static-i18n mkdocs-material - name: Build website run: mkdocs build diff --git a/.github/workflows/pr_preview.yml b/.github/workflows/pr_preview.yml index 94e9dd9..47e5882 100644 --- a/.github/workflows/pr_preview.yml +++ b/.github/workflows/pr_preview.yml @@ -1,5 +1,4 @@ -name: Deploy PR Preview - +name: Deploy PR preview on: pull_request: types: @@ -7,7 +6,6 @@ on: - reopened - synchronize - closed - permissions: contents: write pull-requests: write @@ -16,7 +14,6 @@ jobs: deploy-preview: concurrency: preview-${{ github.ref }} runs-on: ubuntu-latest - steps: - name: Checkout sources uses: actions/checkout@v4 @@ -24,30 +21,18 @@ jobs: - name: Setup Python uses: actions/setup-python@v5 with: - python-version: '3.x' + python-version: 3.x - name: Install dependencies - run: | - pip install mkdocs-dracula-theme mkdocs-static-i18n[material] mkdocs-material + run: pip install mkdocs-dracula-theme mkdocs-static-i18n mkdocs-material - name: Build website if: github.event.action != 'closed' run: mkdocs build - name: Deploy preview - if: github.event.action != 'closed' uses: rossjrw/pr-preview-action@v1 with: source-dir: site preview-branch: gh-pages umbrella-dir: pr-preview - - - name: Remove preview on PR close - if: github.event.action == 'closed' - run: | - git config --global user.email "actions@github.com" - git config --global user.name "GitHub Actions" - git checkout gh-pages - git rm -rf pr-preview/${{ github.event.pull_request.number }} - git commit -m "Remove preview for PR #${{ github.event.pull_request.number }}" - git push origin gh-pages