Introduction

Every month, we come together to delve into the ever-evolving world of technology. This month, we’re diving into the art of code review and unlocking the potential of BitBucket Pipeline.

Code review is not just about finding bugs; it’s an art form that fosters collaboration, improves code quality, and drives innovation. We’ll explore some best practices for effective reviews that will help our company create a culture of constructive feedback within team.

Moreover, we have an exciting journey ahead as we delve into the capabilities of BitBucket Pipeline. Through practical demonstrations, we’ll explore its potential with real-world examples. This includes implementing Magento coding standard validation and setting up a straightforward automated Magento deployment process.

Agenda

1/ Discussing about Coding Review: https://dev.to/tassiofront/mastering-code-review-a-guide-for-reviewers-and-pr-creators-ac6

2/ Bitbucket Pipeline:

Bitbucket Pipelines is a built-in continuous integration and continuous deployment (CI/CD) tool within Bitbucket that automates the process of building, testing, and deploying code.

You need set Variables and secrets and Using SSH keys in Bitbucket Pipelines

A pipeline is defined using a YAML file called bitbucket-pipelines.yml, which is located at the root of your repository.

• Adding Magento coding standard validation

  • Bitbucket Pipeline Configuration for coding standard validation

    Copy to Clipboard

    image: php:8.1 pipelines: pull-requests: "**": - step: name: Check Code Standards script: - apt-get update && apt-get install -y unzip git grep - GIT_EXECUTABLE=/usr/bin/git - $GIT_EXECUTABLE fetch --all - $GIT_EXECUTABLE pull origin ${BITBUCKET_PR_DESTINATION_BRANCH} - $GIT_EXECUTABLE ls-remote origin ${BITBUCKET_PR_DESTINATION_BRANCH} - ORIGIN_DESTINATION_COMMIT=$($GIT_EXECUTABLE merge-base origin/${BITBUCKET_PR_DESTINATION_BRANCH} $BITBUCKET_COMMIT) # Get the list of changed files in the last commit - CHANGED_FILES=$($GIT_EXECUTABLE diff --name-only --diff-filter=ACMRTUXB $ORIGIN_DESTINATION_COMMIT $BITBUCKET_COMMIT -- '*.php' '*.phtml') # Check if there are any PHP or PHTML files changed - | if [ -z "$CHANGED_FILES" ]; then echo "No PHP or PHTML files changed. Skipping PHP_CodeSniffer." exit 0 fi # Install PHP_CodeSniffer - curl -sSL https://github.com/squizlabs/PHP_CodeSniffer/releases/download/3.7.1/phpcs.phar -o phpcs.phar - chmod +x phpcs.phar - curl -sSL https://github.com/PHPCompatibility/PHPCompatibility/archive/9.3.5.zip -o PHPCompatibility.zip - unzip PHPCompatibility.zip - curl -sSL https://github.com/magento/magento-coding-standard/archive/refs/tags/v31.zip -o Magento2.zip - unzip Magento2.zip - ABSOLUTE_DIRECTORY_PATH="$(pwd)" - mv PHPCompatibility-9.3.5 PHPCompatibility - mv magento-coding-standard-31 magento-coding-standard - ./phpcs.phar --config-set installed_paths $ABSOLUTE_DIRECTORY_PATH/PHPCompatibility,$ABSOLUTE_DIRECTORY_PATH/magento-coding-standard # Run PHP_CodeSniffer - ./phpcs.phar --standard=PHPCompatibility --extensions=php,phtml --runtime-set testVersion 8.1 $CHANGED_FILES - ./phpcs.phar --standard=Magento2 --exclude=PSR2.ControlStructures.ControlStructureSpacing --extensions=php,phtml $CHANGED_FILES - ./phpcs.phar --standard=Squiz --sniffs=Squiz.Commenting.ClassComment --extensions=php $CHANGED_FILES - ./phpcs.phar --standard=PSR12 --exclude=PSR2.Classes.PropertyDeclaration,PSR2.Methods.MethodDeclaration,Generic.Files.LineLength,PEAR.Functions.ValidDefaultValue -s --colors --extensions=php $CHANGED_FILES

• Simple auto Magento deployment:

  • Bitbucket Pipeline Configuration for staging deployment

    Copy to Clipboard

    # This is an example Starter pipeline configuration # Use a skeleton to build, test and deploy using manual and parallel steps # ----- # You can specify a custom docker image from Docker Hub as your build environment. pipelines: branches: staging: - step: name: Staging deployment: staging script: - echo "Testing" - pipe: atlassian/ssh-run:0.8.0 variables: SSH_USER: $USER SERVER: $HOST PORT: $PORT COMMAND: '<path-to-magento-directory>/deploys/staging.sh' # The following deployment steps will be executed for each pipeline run. To configure your steps and conditionally deploy see https://support.atlassian.com/bitbucket-cloud/docs/configure-bitbucket-pipelinesyml/
  • staging.sh file:
    Copy to Clipboard

    #!/bin/bash # Navigate to the Magento 2 root directory # Adjust the path to your Magento 2 installation directory cd <path-to-magento-directory> # Pull the latest changes from Git # You might need to specify the branch if you're not pulling from the default branch git pull <repo-name> staging # Enable Magento 2 maintenance mode php bin/magento maintenance:enable # Install the project dependencies via Composer composer install # Run Magento setup upgrade php bin/magento setup:upgrade # If needed, you can also recompile and redeploy static content here php bin/magento setup:di:compile php bin/magento setup:static-content:deploy -f # Disable maintenance mode php bin/magento maintenance:disable echo "Magento 2 has been updated successfully!"

  • Some notes:

    • When adding multiple deployment environments, Bitbucket Pipelines requires the deployments to be ordered as follows in the bitbucket-pipelines.yml file:

      • Test environments

      • Staging environments

      • Production environments