Skip to content

Commit

Permalink
add tests
Browse files Browse the repository at this point in the history
  • Loading branch information
sbaerlocher committed Nov 12, 2023
1 parent 43a82d2 commit 36dbb95
Show file tree
Hide file tree
Showing 3 changed files with 58 additions and 3 deletions.
28 changes: 28 additions & 0 deletions .github/dependabot.yml
Original file line number Diff line number Diff line change
Expand Up @@ -29,3 +29,31 @@ updates:
- "sbaerlocher"
# Specifies GitHub users to be automatically assigned to Dependabot pull requests.
# Here, 'sbaerlocher' is the user who will be assigned to the pull requests.

# Configuration for updating Python dependencies
- package-ecosystem: "pip"
# Specifies that pip (Python package manager) is the package ecosystem to be updated.
directory: "/"
# Sets the directory within the repository where Dependabot looks for Python dependencies.
# "/" indicates the root directory of the repository.

schedule:
interval: "weekly"
# Defines the update frequency. "weekly" means Dependabot checks for updates once a week.
day: "friday"
# Specifies the day of the week when Dependabot should run, set here to Friday.
time: "13:00"
# Sets the time for the Dependabot run. "13:00" is 1:00 PM UTC, corresponding to 2:00 PM in Zurich during winter.

commit-message:
prefix: "chore"
prefix-development: "chore"
include: "scope"
# Configures the commit message settings for Dependabot.
# 'prefix' and 'prefix-development' set a prefix for commit messages.
# 'include: "scope"' includes the scope of the dependencies in the commit message.

assignees:
- "sbaerlocher"
# Specifies GitHub users to be automatically assigned to Dependabot pull requests.
# Here, 'sbaerlocher' is the user who will be assigned to the pull requests.
27 changes: 27 additions & 0 deletions .github/workflows/test.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
name: Run Test
# A descriptive name for the GitHub Actions workflow, indicating its purpose: running tests when a pull request is made.

on:
push:
# Triggers the workflow on pull requests targeting the 'main' branch, ensuring that tests are run on proposed changes.

jobs:
run-tests:
runs-on: ubuntu-latest # Utilizes the latest Ubuntu runner for job execution.

steps:
- uses: actions/checkout@v4
# This step checks out the repository code, making it available for the workflow.

- name: Set up Python
uses: actions/setup-python@v4
with:
python-version: "3.x" # Specify the Python version to use.

- name: Install Dependencies
run: |
pip install -r requirements.txt # Installs Python dependencies specified in requirements.txt.
- name: Build Docs
run: |
./build.sh # Executes the build script to generate the documentation.
6 changes: 3 additions & 3 deletions requirements.txt
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,6 @@
# Created with antsibull-docs 2.5.0.post0

antsibull-docs >= 2.0.0, < 3.0.0
ansible-pygments
sphinx
sphinx-ansible-theme >= 0.9.0
ansible-pygments==0.1.1
sphinx==7.2.6
sphinx-ansible-theme==0.10.2

0 comments on commit 36dbb95

Please sign in to comment.