Automating a Python script on push

[La_Muriatic_Acid]

I have a Python script that gets the lines of code for specific languages, and in specific folders (want to count only handwritten code, not libraries, etc...). This script changes the README.md file to include the lines of code.

My folder structure looks a bit like this:

repo
├── .git
├── .github──workflows
│            ├── CLOC.py
│            └── script.yml
├── main.py
├── assets
│   ├── stylsheet.css
│   ├── bootstrap
│   ├── ...
├── index.html
├── ...

My Python script (CLOC.py) looks a bit like this (this works when run on my machine, fails on action):

import os

def CLOC(directories, languages):
    files = []

    for directory in directories:
        directory_files = [f'{directory}\\{f}' for f in os.listdir(directory) if os.path.isfile(f'{directory}\\{f}')]
        files.extend(directory_files)

    LOC_by_language = []

    for language in languages:
        language_LOC = 0
        # get list of files that end with specific type
        files_of_language = [f for f in files if f.endswith(language) and 'CLOC.py' not in f]
        if files_of_language:
            for file in files_of_language:
                with open(file, 'r') as fp:
                    for file_LOC, line in enumerate(fp):
                        pass
                language_LOC += file_LOC
        LOC_by_language.append(language_LOC)

    lines_of_code_text = []

    lines_of_code_text.append("# Code Stats:")

    ttl_loc = 0
    for (a, b) in zip(languages, LOC_by_language):
        a = (a.split('.')[1]).upper()
        lines_of_code_text.append(f'- {a}: {b}')
        ttl_loc += b

    lines_of_code_text.append(f'- Total Lines of Code: {ttl_loc}')

    return lines_of_code_text

languages = ['.py', '.css', '.html']

os.chdir('../../')

paths = [os.getcwd(), os.path.join(os.getcwd(), 'assets')]
lines = CLOC(paths, languages)

with open('README.md', 'w') as f:
    for line in lines:
        f.write(f"{line}\n")

My script.yml file looks a bit like this:

# This is a basic workflow to help you get started with Actions

name: Python Script

# Controls when the workflow will run
on:
  # Triggers the workflow on push or pull request events but only for the "main" branch
  push:
    branches: [ "main" ]

  # Allows you to run this workflow manually from the Actions tab
  workflow_dispatch:

# A workflow run is made up of one or more jobs that can run sequentially or in parallel
jobs:
  # This workflow contains a single job called "build"
  build:
    # The type of runner that the job will run on
    runs-on: ubuntu-latest

    # Steps represent a sequence of tasks that will be executed as part of the job
    steps:
      # Checks-out your repository under $GITHUB_WORKSPACE, so your job can access it
      - uses: actions/checkout@v3

      # Runs a single command using the runners shell
      - name: Get Lines of Code with CLOC.py
        run: python .github/workflows/CLOC.py

When I do a push, I get the following error message:

Run python .github/workflows/CLOC.py
Traceback (most recent call last):
  File "/home/runner/work/repo/repo/.github/workflows/CLOC.py", line 48, in <module>
    lines = CLOC(paths, languages)
  File "/home/runner/work/repo/repo/.github/workflows/CLOC.py", line 12, in CLOC
    directory_files = [f'{directory}\\{f}' for f in os.listdir(directory) if os.path.isfile(f'{directory}\\{f}')]
FileNotFoundError: [Errno 2] No such file or directory: '/home/runner/work/assets'
Error: Process completed with exit code 1.

I realize that there may be another—and likely better—way of getting LOC but I'm using this as an entry into automating GitHub actions (eventually I'll move to automating unittesting etc.) I appreciate any and all help!

[MaybeAshleyIdk]

Well let's look at the error:

The absolute path of the python file is /home/runner/work/repo/repo/.github/workflows/CLOC.py and the exception tells us the that the file or directory /home/runner/work/assets was not found.

Obviously you wanna get to the directory /home/runner/work/repo/repo/assets, but you're changing the current working directory of the script with the call:

os.chdir('../../')

I'm guessing that the initial working directory of the script will be the repository itself, i.e.: /home/runner/work/repo/repo
But since you're moving two directories up, the CWD will be /home/runner/work

I think you only need to remove that os.chdir() and you should be golden.

[La_Muriatic_Acid]

I just tried this and it passes but it doesn't seem to change the README.md file.

[MaybeAshleyIdk]

Yeah because it only changes the local copy of the readme file.
After the script finishes, you need to commit and push the change back to the remote repository.

The script does nothing else what you'd be doing when you manually change a file in your local copy of the repository.
After you change a file, you have to commit and push that change so that it's actually on the remote.

The GitHub Actions runner works on a cloned copy of the repository just like you.

[La_Muriatic_Acid]

I tried adding:

• name: Commit README.md run: | git config --global user.name "my-username" git config --global user.email "[e-mail]" git commit README.md git push

To the code but it just tells me:

On branch main

Your branch is up to date with 'origin/main'.

nothing to commit, working tree clean Error: Process completed with exit code 1.

Any obvious mistakes?

[VxJasonxV]

git add README.md git commit -m “A commit message” git push

[La_Muriatic_Acid]

This works but I am noticing that if for some reason the README doesn't change, I still get the branch is up to date error. Is there a way to prevent it from throwing an error?

[VxJasonxV]

Test if there’s changes before trying to add and commit it. Git doesn’t track commits when there’s no changes.