config.yml

version: 2
aliases:
  - &deploy_ssh_fingerprint "e8:d7:da:b8:6a:fb:75:50:8d:5f:48:61:3c:46:49:50"

  - &container_config
    working_directory: /workspace/code
    docker:
      - image: drevops/ci-runner:24.11.0
        environment:
          COMPOSER_ALLOW_SUPERUSER: 1
          DEPLOY_SSH_FINGERPRINT: *deploy_ssh_fingerprint

  - &step_setup_git
    run:
      name: Setup git
      command: |
        mkdir -p "$HOME/.ssh/"
        echo -e "Host *\n\tStrictHostKeyChecking no\n" > "$HOME/.ssh/config"
        DEPLOY_SSH_FILE="${DEPLOY_SSH_FINGERPRINT//:}"
        DEPLOY_SSH_FILE="$HOME/.ssh/id_rsa_${DEPLOY_SSH_FILE//\"}"
        if [ -f "$DEPLOY_SSH_FILE" ]; then
          echo "Found Deploy SSH key file $DEPLOY_SSH_FILE"
          ssh-add -D > /dev/null
          ssh-add "$DEPLOY_SSH_FILE"
        fi
        git config --global user.name "$DEPLOY_USER_NAME"
        git config --global user.email "$DEPLOY_USER_EMAIL"

jobs:
  build:
    <<: *container_config
    steps:
      - attach_workspace:
          at: /workspace

      - checkout

      - add_ssh_keys:
          fingerprints:
            - *deploy_ssh_fingerprint

      - *step_setup_git

      - run:
          name: Validate composer.json
          command: composer validate --ansi --strict

      - run:
          name: Install dependencies
          command: composer install --ansi --no-progress --no-interaction --no-suggest --prefer-dist

      - run:
          name: Lint code
          command: composer lint

      - run:
          name: Run tests
          command: composer test

      - persist_to_workspace:
          root: /workspace
          paths:
            - code

  # Demonstration of deployment in 'force-push' mode.
  deploy-force-push:
    <<: *container_config
    steps:
      - attach_workspace:
          at: /workspace

      - add_ssh_keys:
          fingerprints:
            - *deploy_ssh_fingerprint

      - *step_setup_git

      - checkout

      # Test file will have a consistent name between deployments, but
      # the contents will be added to on each deployment to simulate
      # changes in the source repository.
      - run:
          name: Prepare test file.
          command: |
            export TEST_FILE="test-file--force-push--circleci--${CIRCLE_BRANCH//\//-}.txt"
            echo "Deployment 1 for branch $CIRCLE_BRANCH" > $TEST_FILE
            date "+%Y%m%d-%H%M%S" >> $TEST_FILE
            cat $TEST_FILE
            echo $TEST_FILE > $HOME/test-file.txt

      - run:
          name: Deployment 1
          command: |
            ./git-artifact \
              git@github.com:drevops/git-artifact-destination.git \
              --branch=mode--force-push--circleci--[branch] \
              --mode=force-push \
              --log=$HOME/report--mode--force-push.txt \
              -vvv

            DEPLOYED_BRANCH=$(sed -n 's/Remote branch://p' $HOME/report--mode--force-push.txt | sed 's/ //g')
            echo "Deployed to $DEPLOYED_BRANCH"
            echo
            echo "See https://github.com/drevops/git-artifact-destination/blob/$DEPLOYED_BRANCH/$(cat $HOME/test-file.txt)"
            rm $HOME/report--mode--force-push.txt

      - run:
          name: Update the test file to simulate changes in the source repository.
          command: |
            export TEST_FILE="test-file--force-push--circleci--${CIRCLE_BRANCH//\//-}.txt"
            echo "Deployment 2 for branch $CIRCLE_BRANCH" >> $TEST_FILE
            date "+%Y%m%d-%H%M%S" >> $TEST_FILE
            cat $TEST_FILE

      - run:
          name: Deployment 2
          command: |
            ./git-artifact \
              git@github.com:drevops/git-artifact-destination.git \
              --branch=mode--force-push--circleci--[branch] \
              --mode=force-push \
              --log=$HOME/report--mode--force-push.txt \
              -vvv

            DEPLOYED_BRANCH=$(sed -n 's/Remote branch://p' $HOME/report--mode--force-push.txt | sed 's/ //g')
            echo "Deployed to $DEPLOYED_BRANCH"
            echo
            echo "See https://github.com/drevops/git-artifact-destination/blob/$DEPLOYED_BRANCH/$(cat $HOME/test-file.txt)"

  # Demonstration of deployment in 'branch' mode.
  # Note that by design, pushing into the same branch will result in the failure
  # of the second push. This is because the mode is intended to create a new
  # branch per artifact deployment.
  deploy-branch:
    <<: *container_config
    steps:
      - attach_workspace:
          at: /workspace

      - add_ssh_keys:
          fingerprints:
            - *deploy_ssh_fingerprint

      - *step_setup_git

      - checkout

      # Test file will have a consistent name between deployments, but
      # the contents will be added to on each deployment to simulate
      # changes in the source repository.
      # Since each deployment in this mode creates a new branch, the test file
      # will be pushed to a new branch each time and won't be updated in
      # existing branches.
      - run:
          name: Prepare test file.
          command: |
            export TEST_FILE="test-file--branch--circleci--${CIRCLE_BRANCH//\//-}.txt"
            echo "Deployment 1 for branch $CIRCLE_BRANCH" > $TEST_FILE
            date "+%Y%m%d-%H%M%S" >> $TEST_FILE
            cat $TEST_FILE
            echo $TEST_FILE > $HOME/test-file.txt

      - run:
          name: Deployment 1
          command: |
            ./git-artifact \
              git@github.com:drevops/git-artifact-destination.git \
              --branch=mode--branch--circleci--[branch]--[timestamp:Y-m-d_H-i] \
              --mode=branch \
              --log=$HOME/report--mode--branch.txt \
              -vvv

            DEPLOYED_BRANCH=$(sed -n 's/Remote branch://p' $HOME/report--mode--branch.txt | sed 's/ //g')
            echo "Deployed to $DEPLOYED_BRANCH"
            echo
            echo "See https://github.com/drevops/git-artifact-destination/blob/$DEPLOYED_BRANCH/$(cat $HOME/test-file.txt)"
            rm $HOME/report--mode--branch.txt

      - run:
          name: Deployment 2 - same branch
          command: |
            ./git-artifact \
              git@github.com:drevops/git-artifact-destination.git \
              --branch=mode--branch--circleci--[branch]--[timestamp:Y-m-d_H-i] \
              --mode=branch \
              --log=$HOME/report--mode--branch.txt \
              -vvv \
              && { echo "Expected to fail as repeated pushes to the same branch are not allowed, but succeeded" >&2; exit 1; } || echo "Failed as expected"

      - run:
          name: Update the test file to simulate changes in the source repository.
          command: |
            export TEST_FILE="test-file--branch--circleci--${CIRCLE_BRANCH//\//-}.txt"
            echo "Deployment 2 for branch $CIRCLE_BRANCH" > $TEST_FILE
            date "+%Y%m%d-%H%M%S" >> $TEST_FILE
            cat $TEST_FILE

      - run:
          name: Deployment 2 - new branch
          command: |
            ./git-artifact \
              git@github.com:drevops/git-artifact-destination.git \
              --branch=mode--branch--circleci--[branch]--[timestamp:Y-m-d_H-i-s] \
              --mode=branch \
              --log=$HOME/report--mode--branch.txt \
              -vvv

            DEPLOYED_BRANCH=$(sed -n 's/Remote branch://p' $HOME/report--mode--branch.txt | sed 's/ //g')
            echo "Deployed to $DEPLOYED_BRANCH"
            echo
            echo "See https://github.com/drevops/git-artifact-destination/blob/$DEPLOYED_BRANCH/$(cat $HOME/test-file.txt)"

workflows:
  version: 2
  main:
    jobs:
      - build
      - deploy-force-push:
          requires:
            - build
      - deploy-branch:
          requires:
            - build