Skip to content

Commit

Permalink
chor (CI/CD): performance optimized in CI/CD process.
Browse files Browse the repository at this point in the history
  • Loading branch information
Almas-Ali committed May 31, 2024
1 parent 49a6f4d commit e5c1106
Show file tree
Hide file tree
Showing 2 changed files with 57 additions and 6 deletions.
45 changes: 41 additions & 4 deletions .github/workflows/deploy.yaml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
name: Deploy MkDocs site to GitHub Pages
name: deploy

on:
push:
Expand All @@ -17,23 +17,60 @@ jobs:
uses: actions/setup-python@v5
with:
python-version: "3.11"
cache: "pip"
cache-dependency-path: ./requirements.txt

- name: Install dependencies
run: |
python -m pip install --upgrade pip
pip install mkdocs mkdocs-material
pip install -r requirements.txt
- name: Check for changes in docs/ or mkdocs.yml
id: check_changes
run: |
git diff --name-only > changed_files.txt
if grep -qE '(^docs/|^mkdocs.yml)' changed_files.txt; then
echo "Changes detected in the following files:"
cat changed_files.txt
rm changed_files.txt
else
echo "No changes detected."
exit 0
fi
- name: Set up Node.js
uses: actions/setup-node@v4
with:
node-version: "18"
cache: "npm"
cache-dependency-path: ./package.json

- name: Install markdownlint-cli
run: npm install -g markdownlint-cli

- name: Lint Markdown files
run: markdownlint **/*.md

- name: Build MkDocs site
run: mkdocs build

- name: Install Ruby and Bundler
run: sudo apt-get install -y ruby-full

- name: Install HTML Proofer
run: gem install html-proofer

- name: Test MkDocs site
run: htmlproofer ./site --only-4xx --check-html --check-img-http --check-favicon --check-external-hash --check-opengraph --check-opengraph-image

- name: Deploy to GitHub Pages
uses: peaceiris/actions-gh-pages@v4
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_dir: ./site
keep_files: false
destination_dir: .
user_name: 'github-actions[bot]'
user_email: 'github-actions[bot]@users.noreply.github.com'
user_name: "github-actions[bot]"
user_email: "github-actions[bot]@users.noreply.github.com"
publish_branch: gh-pages
full_commit_message: ${{ github.event.head_commit.message }}
18 changes: 16 additions & 2 deletions .github/workflows/tests.yaml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
name: Test MkDocs site
name: tests

on: [push, pull_request]

Expand All @@ -15,11 +15,25 @@ jobs:
with:
python-version: "3.11"
cache: "pip"
cache-dependency-path: ./requirements.txt

- name: Install dependencies
run: |
python -m pip install --upgrade pip
pip install mkdocs mkdocs-material
pip install -r requirements.txt
- name: Check for changes in docs/ or mkdocs.yml
id: check_changes
run: |
git diff --name-only > changed_files.txt
if grep -qE '(^docs/|^mkdocs.yml)' changed_files.txt; then
echo "Changes detected in the following files:"
cat changed_files.txt
rm changed_files.txt
else
echo "No changes detected."
exit 0
fi
- name: Set up Node.js
uses: actions/setup-node@v4
Expand Down

0 comments on commit e5c1106

Please sign in to comment.