Add support for GitLab CI ENV variable CI_NODE_INDEX starting from 1 #83
Conversation
Since GitLab 11.5, you can define `parallel: x` (2 to 50) to a job and have it run in multiple workers. You no longer need to define all of them nor define any environmental variable manually. You can read more from the documentation here: https://docs.gitlab.com/ee/ci/yaml/#parallel You can read about pre-defined ENV variables in GitLab CI here: https://docs.gitlab.com/ee/ci/variables/README.html#predefined-variables-environment-variables
|
@ArturT I've added support to the new Change include tests and I've added an entry to the CHANGELOG. Could you please review? |
|
@brodock It looks good. I'm going to merge it and release a new version of knapsack probably tomorrow. Thanks for PR! |
|
@brodock I've just released a new version of the knapsack. Thanks for the help! |
| @@ -43,6 +43,12 @@ def semaphore_current_thread | |||
| def snap_ci_worker_index | |||
| index_starting_from_one(ENV['SNAP_WORKER_INDEX']) | |||
| end | |||
|
|
|||
| def gitlab_ci_node_index | |||
| return unless ENV['GITLAB_CI'] | |||
There was a problem hiding this comment.
Should it check CI_SERVER_VERSION as pre 11.5 it was not supported? I guess it's not backward compatible.
There was a problem hiding this comment.
I'm not sure if this is the best idea. Before 11.5 the CI would not set CI_NODE_INDEX nor CI_NODE_TOTAL, so anyone using knapsack would have to define a custom variable itself (as we were doing).
There are then few scenarios:
- GitLab instance is updated: Because it requires a change in the
.gitlab-ci.yamlfile, this has no effect on your current jobs, so nothing changes for you. - Knapsack is also updated: When you upgrade the gem, this will break one of your builds because of the index start number change, so you can re-define the
CI_NODE_INDEXmanually or switch to use theparallel:keyword. Checking for theCI_SERVER_VERSIONwould not prevent this to break, and as you are updating part of your code, this would blow on your feature branch and you can fix it as normal procedure. - Only Knapsack is updated: It's similar to the case before, the only difference is that checking for the version would make your tests work, but that is hiding something that will eventually break in the near future, but will be harder to debug because you will not have the clue about the
knapsackupgrade as cause/consequence.
Since GitLab 11.5, you can define
parallel: x(2 to 50) to a job and have itrun in multiple workers. You no longer need to define all of them
nor define any environmental variable manually.
You can read more from the documentation here:
https://docs.gitlab.com/ee/ci/yaml/#parallel
You can read about pre-defined ENV variables in GitLab CI here:
https://docs.gitlab.com/ee/ci/variables/README.html#predefined-variables-environment-variables