From 1a5b109488f3c6426105892ac7e0ab31d0ca4818 Mon Sep 17 00:00:00 2001 From: Davide Ricci Date: Wed, 18 Jun 2025 18:07:35 +0000 Subject: [PATCH] Update .gitlab-ci.yml file --- .gitlab-ci.yml | 203 ++++++++++++++++++------------------------------- 1 file changed, 73 insertions(+), 130 deletions(-) diff --git a/.gitlab-ci.yml b/.gitlab-ci.yml index 768c493..755107c 100644 --- a/.gitlab-ci.yml +++ b/.gitlab-ci.yml @@ -5,175 +5,118 @@ image: python:3.12 variables: PROJECT: "noctua" PIP_CACHE_DIR: "$CI_PROJECT_DIR/.cache/pip" - FORMAT_TARGETS: "${PROJECT}" # For sed, autopep8, isort - PYLINT_TARGETS: "${PROJECT}" # For pylint + FORMAT_TARGETS: "${PROJECT}" + PYLINT_TARGETS: "${PROJECT}" GIT_USER_EMAIL: "davide.ricci@inaf.it" GIT_USER_NAME: "Davide GitLab CI" FORMATTED_BRANCH_NAME: "validated" cache: - key: "$CI_COMMIT_REF_SLUG" # Cache pip downloads per branch + key: "$CI_COMMIT_REF_SLUG" paths: - .cache/pip - # - venv/ stages: - - setup_and_format - - lint # Does not modify code - - deploy_docs + - validate # Combined setup, formatting, and linting + - deploy - auto_commit -# Job 1: Install ${PROJECT} and its dependencies -install_project: - stage: setup_and_format - tags: - - git-run-ia2 - script: - - echo "Current directory $(pwd)" - - ls -la - - echo "Python version $(python -v)" - - pip install --upgrade pip - - echo "Installing project '${PROJECT}' and its dependencies..." - - pip install -e . - - echo "${PROJECT} installation complete." - artifacts: - paths: - # Pass the entire workspace. This includes the checked-out code - # or if -e . modifies local files (e.g. .egg-info). - - . # The current working directory state - -# Job 2: Remove Trailing Whitespaces -fix_trailing_whitespaces: - stage: setup_and_format +# Job 1: Install dependencies, format code, and lint +# This single job is more efficient than the previous multi-job chain. +validate_code: + stage: validate tags: - git-run-ia2 - needs: - - job: install_project - artifacts: true - script: - - echo "Current directory $(pwd)" - - ls -la - - echo "Removing trailing whitespaces from '${FORMAT_TARGETS}' directory..." - - find "${FORMAT_TARGETS}" -type f -name "*.py" -exec sed -i 's/[[:space:]]*$//' {} \; - - echo "Trailing whitespaces removed." - artifacts: - paths: - - . # Pass the modified workspace - -# Job 3: Apply isort -apply_isort: - stage: setup_and_format - tags: - - git-run-ia2 - needs: - - job: fix_trailing_whitespaces - artifacts: true before_script: - - pip install isort + - pip install --upgrade pip + # Install all tools at once + - pip install ".[dev]" # Assuming you have a pyproject.toml with dev dependencies like isort, autopep8, pylint + # Or install them manually: + # - pip install -e . + # - pip install isort autopep8 pylint script: - - echo "Current directory $(pwd)" - - ls -la - - echo "Applying isort to '${FORMAT_TARGETS}' directory..." - # isort will use pyproject.toml for configuration + # --- STEP 1: Format Code --- + - echo "Removing trailing whitespaces..." + - find "${FORMAT_TARGETS}" -type f -name "*.py" -exec sed -i 's/[[:space:]]*$//' {} \; + + - echo "Applying isort..." - isort "${FORMAT_TARGETS}" - - echo "isort formatting complete." - artifacts: - paths: - - . # Pass the modified workspace - -# Job 4: Apply autopep8 -apply_autopep8: - stage: setup_and_format - tags: - - git-run-ia2 - needs: - - job: apply_isort - artifacts: true - before_script: - - pip install autopep8 - script: - - echo "Current directory $(pwd)" - - ls -la - - echo "Applying autopep8 to '${FORMAT_TARGETS}' directory..." + + - echo "Applying autopep8..." - autopep8 --in-place --recursive --aggressive --aggressive "${FORMAT_TARGETS}" - - echo "autopep8 formatting complete." - artifacts: - paths: - - . # Pass the modified workspace + - echo "Formatting complete." -# Job 5: Run Pylint -run_pylint: - stage: lint - tags: - - git-run-ia2 - needs: - - job: apply_autopep8 - artifacts: true - before_script: - - pip install pylint - script: - - echo "Current directory $(pwd)" - - echo "Running pylint on '${PYLINT_TARGETS}'..." - - pylint --version - - pylint --rcfile=.pylintrc --fail-on=E,F ${PYLINT_TARGETS}/sequencer.py || echo "Pylint finished with exit code $(( $? &2)) (non-zero indicates issues)" + # --- STEP 2: Lint the formatted code --- + - echo "Running pylint..." + - pylint --rcfile=.pylintrc --fail-on=E,F ${PYLINT_TARGETS}/sequencer.py - echo "Pylint check complete." - #rules: - # - if: $CI_PIPELINE_SOURCE == "merge_request_event" - # - if: $CI_COMMIT_BRANCH == $CI_DEFAULT_BRANCH - # - when: manual - # allow_failure: true # Allow manual trigger to not fail overall pipeline if desired - + artifacts: + # Pass the formatted code to the commit job + paths: + - "${PROJECT}/" + - ".pylintrc" # And any other relevant files -# Job 6: Create documentation -# This defines a job named 'pages'. GitLab recognizes this special name -# and knows that its purpose is to deploy a website to GitLab Pages. +# Job 2: Create and deploy documentation to GitLab Pages pages: - stage: deploy_docs + stage: deploy tags: - - git-run-ia2 - + - git-run-ia2 before_script: - pip install --upgrade pip - - echo "Installing project '${PROJECT}' and its dependencies..." + # Install project so Sphinx can import it - pip install -e . - - echo "${PROJECT} installation complete." + # Install doc dependencies - pip install -r docs/requirements.txt script: - - echo "Current directory $(pwd)" - - echo "Building docs..." - - sphinx-apidoc -o docs/source noctua - - sphinx-build -b html docs/source docs/public/html + - echo "Building documentation..." + - sphinx-apidoc -o docs/source ${PROJECT} + # The final output directory MUST be named 'public' for GitLab Pages + - sphinx-build -b html docs/source public artifacts: paths: - public rules: + # Only run on the default branch - if: $CI_COMMIT_BRANCH == $CI_DEFAULT_BRANCH - -# Job 7: commit in branch + +# Job 3: Commit the formatted code to a new branch commit_formatted_code: stage: auto_commit tags: - git-run-ia2 needs: - - job: run_pylint # Must pass pylint - - job: apply_autopep8 # Needs the final code state from formatting + - job: validate_code # Depends on the single validation job artifacts: true before_script: - - git config --global user.email "davide.ricci@inaf.it" - - git config --global user.name "CI Bot" - - git checkout "$CI_COMMIT_SHA" + - git config --global user.email "${GIT_USER_EMAIL}" + - git config --global user.name "${GIT_USER_NAME}" script: - - echo "Checking for changes and committing to ${FORMATTED_BRANCH_NAME} branch..." + - echo "Creating/updating branch '${FORMATTED_BRANCH_NAME}' with formatted code..." + # Create the new branch from the original commit + - git checkout -B "${FORMATTED_BRANCH_NAME}" + + # Add all the changes from the formatted code (which came from artifacts) - git add . - - echo "Creating/updating branch '${FORMATTED_BRANCH_NAME}' based on commit $CI_COMMIT_SHA..." - - git checkout -B "${FORMATTED_BRANCH_NAME}" "$CI_COMMIT_SHA" - - MAIN_COMMIT_MSG=$(git log -1 --pretty=%B $CI_COMMIT_SHA) - - | - git commit -m "$MAIN_COMMIT_MSG - - Source Commit: $CI_COMMIT_SHA - - Date: $(date +"%Y-%m-%d %H:%M:%S") - - Job ID: $CI_JOB_ID - - Pipeline ID: $CI_PIPELINE_ID - - [skip ci]" - - git push --force https://davide.ricci:$GITLAB_TOKEN@www.ict.inaf.it/gitlab/davide.ricci/software-di-controllo.git ${FORMATTED_BRANCH_NAME} + + # Check if there's anything to commit + - | + if git diff --staged --quiet; then + echo "No formatting changes to commit." + else + echo "Committing formatting changes..." + MAIN_COMMIT_MSG=$(git log -1 --pretty=%B $CI_COMMIT_SHA) + git commit -m "style: Apply automatic formatting + + ${MAIN_COMMIT_MSG} + --- + CI Job: $CI_JOB_ID + Source Commit: $CI_COMMIT_SHA + [skip ci]" + + # Push the new branch to the repository + git push --force "https://gitlab-ci-token:${GITLAB_TOKEN}@${CI_SERVER_HOST}/${CI_PROJECT_PATH}.git" "${FORMATTED_BRANCH_NAME}" + fi + rules: + # Only run this when pushing to a non-default branch, to avoid loops. + - if: $CI_COMMIT_BRANCH != $CI_DEFAULT_BRANCH -- GitLab