Skip to content

Add README.md for the docs directory #22

Add README.md for the docs directory

Add README.md for the docs directory #22

Workflow file for this run

name: X17-Surface Python Linter
# Controls when the action will run.
# Workflow runs when manually triggered using the UI, or when a push or pull request is made to the main branch
on:
push:
branches:
- master
workflow_dispatch:
permissions:
contents: write # Grant write access to repository contents
jobs:
format:
runs-on: ubuntu-latest
steps:
- name: Checkout repository
uses: actions/checkout@v4
- name: Set up Python
uses: actions/setup-python@v5
with:
python-version: '3.x'
- name: Install Black
run: |
python -m pip install --upgrade pip
pip install black
- name: Run Black to format code
run: black .
- name: Commit changes if there are any
run: |
git config --local user.name "GitHub Action"
git config --local user.email "[email protected]"
git diff --exit-code || (git add . && git commit -m "Auto-format code using Black" && git push)
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} # Use GitHub token for authentication