Skip to content

Commit

Permalink
Add comments, remove redundant pre-commit job
Browse files Browse the repository at this point in the history
  • Loading branch information
Callum027 committed Dec 9, 2023
1 parent 345d61f commit 401da47
Show file tree
Hide file tree
Showing 5 changed files with 6 additions and 15 deletions.
12 changes: 0 additions & 12 deletions .github/workflows/build.yml
Original file line number Diff line number Diff line change
Expand Up @@ -5,20 +5,8 @@ on:
workflow_call:

jobs:
build-precommit:
name: Run pre-commit hooks
runs-on: ubuntu-22.04
steps:
- uses: actions/checkout@v3
with:
submodules: true
- uses: actions/setup-python@v4
with:
python-version: "3.11"
- uses: pre-commit/[email protected]
build-mkdocs:
name: Build docs using MkDocs
needs: build-precommit
runs-on: ubuntu-22.04
steps:
- name: Checkout with submodules
Expand Down
4 changes: 3 additions & 1 deletion .github/workflows/main.yml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
name: Main
name: main

on:
push:
Expand All @@ -7,7 +7,9 @@ on:

jobs:
build:
name: Build docs
uses: ./.github/workflows/build.yml
publish:
name: Publish docs
uses: ./.github/workflows/publish.yml
needs: build
2 changes: 1 addition & 1 deletion .github/workflows/pre-commit.yml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
name: Pre-commit hooks
name: Pre-commit Hooks

on:
workflow_dispatch:
Expand Down
1 change: 0 additions & 1 deletion .github/workflows/publish.yml
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,6 @@ on:
jobs:
publish-githubpages:
name: Publish docs to GitHub Pages
if: ${{ github.event.workflow_run.conclusion == 'success' }}
runs-on: ubuntu-22.04
steps:
- name: Download Buildarr Docs from build artifacts
Expand Down
2 changes: 2 additions & 0 deletions .github/workflows/pull_request.yml
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,9 @@ on:

jobs:
pre-commit:
name: Run pre-commit hooks
uses: ./.github/workflows/pre-commit.yml
build:
name: Build docs
uses: ./.github/workflows/build.yml
needs: pre-commit

0 comments on commit 401da47

Please sign in to comment.