DEV Community

Nasrul Hazim Bin Mohamad
Nasrul Hazim Bin Mohamad

Posted on

Formatting and Linting Your Python Codes with GitHub Actions

#python #github #cicd

In the ever-evolving landscape of software development, maintaining code quality and consistency is crucial. One of the most effective ways to ensure that your codebase remains clean and adheres to best practices is by automating formatting and linting processes. In this blog post, we’ll walk through setting up a GitHub Actions workflow designed to automate code formatting and linting for Python projects. We'll explore the configuration and the steps involved, and how it can save you time and reduce errors in your code.

Introduction to GitHub Actions

GitHub Actions is a powerful tool that allows you to automate workflows directly within your GitHub repository. From running tests to deploying applications, GitHub Actions can handle various tasks based on events like pushes, pull requests, and more. In this example, we’ll focus on automating code formatting and linting using GitHub Actions.

The Workflow Breakdown

Here’s a detailed look at the GitHub Actions workflow for formatting and linting Python code:

name: Format and Lint on: push: branches: - master pull_request: branches: - master jobs: format-and-lint: runs-on: ubuntu-latest steps: - name: Checkout code uses: actions/checkout@v3 - name: Set up Python uses: actions/setup-python@v4 with: python-version: '3.9' # Specify the Python version to use - name: Install dependencies run: | python -m pip install --upgrade pip pip install black isort autopep8 - name: Run Black run: black . - name: Run isort run: isort . - name: Run autopep8 run: autopep8 --in-place --recursive . - name: Commit changes if any env: GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} run: | # Check for changes git diff --exit-code || { echo "Changes detected. Committing changes..." # Configure Git user git config --global user.name "github-actions" git config --global user.email "actions@github.com" # Stage all changes git add . # Commit changes git commit -m "Apply code formatting and linting fixes" # Push changes git push origin HEAD }
Enter fullscreen mode Exit fullscreen mode

Workflow Components Explained

  1. Trigger Events: 
 on: push: branches: - master pull_request: branches: - master
Enter fullscreen mode Exit fullscreen mode

The workflow is triggered on pushes and pull requests to the master branch. This ensures that every change to the main branch or pull request is automatically formatted and linted.

  1. Job Configuration: 
 jobs: format-and-lint: runs-on: ubuntu-latest
Enter fullscreen mode Exit fullscreen mode

The job runs on the latest version of Ubuntu. This is the environment where your formatting and linting will occur.

  1. Checkout Code: 
 - name: Checkout code uses: actions/checkout@v3
Enter fullscreen mode Exit fullscreen mode

This step checks out your repository code, allowing subsequent steps to access and modify it.

  1. Set Up Python: 
 - name: Set up Python uses: actions/setup-python@v4 with: python-version: '3.9'
Enter fullscreen mode Exit fullscreen mode

This step sets up Python 3.9 in the workflow environment. Adjust this to match the Python version used in your project.

  1. Install Dependencies: 
 - name: Install dependencies run: | python -m pip install --upgrade pip pip install black isort autopep8
Enter fullscreen mode Exit fullscreen mode

Here, essential Python packages for formatting and linting—black, isort, and autopep8—are installed.

  1. Run Formatters: 
 - name: Run Black run: black . - name: Run isort run: isort . - name: Run autopep8 run: autopep8 --in-place --recursive .
Enter fullscreen mode Exit fullscreen mode

These steps apply code formatting using black, isort for import sorting, and autopep8 for additional formatting adjustments.

  1. Commit Changes: 
 - name: Commit changes if any env: GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} run: | git diff --exit-code || { echo "Changes detected. Committing changes..." git config --global user.name "github-actions" git config --global user.email "actions@github.com" git add . git commit -m "Apply code formatting and linting fixes" git push origin HEAD }
Enter fullscreen mode Exit fullscreen mode

If formatting or linting changes are made, this step commits and pushes them back to the repository. It uses a GitHub token for authentication and configures Git with a generic user for commits.

Benefits of This Workflow

  1. Consistency: Ensures that code follows consistent formatting rules, improving readability and maintainability.
  2. Automation: Automates the formatting and linting process, reducing manual intervention and potential errors.
  3. Integration: Seamlessly integrates with your GitHub repository, running checks automatically on code changes.

Conclusion

Implementing a GitHub Actions workflow for formatting and linting is a smart way to maintain code quality and consistency across your projects. By automating these processes, you can focus more on writing code and less on formatting issues. The workflow provided here serves as a solid foundation, but you can customize it further based on your project's specific needs. Start integrating this workflow into your repositories today and experience the benefits of automated code quality management!

Top comments (0)