From 2e0c58ec3eed291f7ad2e31e40a6c221b6e9bb6b Mon Sep 17 00:00:00 2001 From: George Kalpakas Date: Wed, 9 Jan 2019 14:40:57 +0200 Subject: [PATCH] docs: document why not using `compare-url` orb (#28010) Discussed in https://github.com/angular/angular/pull/27775#issuecomment-452565603. PR Close #28010 --- .circleci/get-commit-range.js | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/.circleci/get-commit-range.js b/.circleci/get-commit-range.js index d54930f1ef..f8cd211213 100644 --- a/.circleci/get-commit-range.js +++ b/.circleci/get-commit-range.js @@ -74,6 +74,16 @@ * --- * Inspired by https://circleci.com/orbs/registry/orb/iynere/compare-url * (source code: https://github.com/iynere/compare-url-orb). + * + * We are not using the `compare-url` orb for the following reasons: + * 1. (By looking at the code) it would only work if the rerun workflow is the latest workflow on + * the branch (which is not guaranteed to be true). + * 2. It is less efficient (e.g. makes unnecessary CircleCI API requests for builds on different + * branches, installs extra dependencies, persists files to the workspace (as a means of passing + * the result to the calling job), etc.). + * 3. It is slightly more complicated to setup and consume than our own script. + * 4. Its implementation is more complicated than needed for our usecase (e.g. handles different git + * providers, handles newly created branches, etc.). */ // Imports