config.yml 8.2 KB
Newer Older
1
version: 2.1
2
setup: true
3
orbs:
4
    continuation: circleci/continuation@0.1.0
5

6
7
8
9
parameters:
    nightly:
        type: boolean
        default: false
10

Julien Chaumond's avatar
Julien Chaumond committed
11
jobs:
12
13
14
    # Ensure running with CircleCI/huggingface
    check_circleci_user:
        docker:
15
            - image: cimg/python:3.8.12
16
17
18
19
20
21
22
23
24
        parallelism: 1
        steps:
            - run: echo $CIRCLE_PROJECT_USERNAME
            - run: |
                if [ "$CIRCLE_PROJECT_USERNAME" = "huggingface" ]; then
                    exit 0
                else
                    echo "The CI is running under $CIRCLE_PROJECT_USERNAME personal account. Please follow https://support.circleci.com/hc/en-us/articles/360008097173-Troubleshooting-why-pull-requests-are-not-triggering-jobs-on-my-organization- to fix it."; exit -1
                fi
Sylvain Gugger's avatar
Sylvain Gugger committed
25
26
    # Fetch the tests to run
    fetch_tests:
27
        working_directory: ~/transformers
28
        docker:
29
            - image: cimg/python:3.8.12
30
31
32
        parallelism: 1
        steps:
            - checkout
33
            - run: pip install --upgrade pip
Sylvain Gugger's avatar
Sylvain Gugger committed
34
35
36
37
            - run: pip install GitPython
            - run: pip install .
            - run: mkdir -p test_preparation
            - run: python utils/tests_fetcher.py | tee tests_fetched_summary.txt
38
            - store_artifacts:
39
                  path: ~/transformers/tests_fetched_summary.txt
40
            - run: |
Sylvain Gugger's avatar
Sylvain Gugger committed
41
                if [ -f test_list.txt ]; then
42
                    cp test_list.txt test_preparation/test_list.txt
Sylvain Gugger's avatar
Sylvain Gugger committed
43
44
45
                else
                    touch test_preparation/test_list.txt
                fi
46
47
48
49
50
51
            - run: |
                  if [ -f examples_test_list.txt ]; then
                      mv examples_test_list.txt test_preparation/examples_test_list.txt
                  else
                      touch test_preparation/examples_test_list.txt
                  fi
52
53
54
55
56
57
            - run: |
                if [ -f doctest_list.txt ]; then
                    cp doctest_list.txt test_preparation/doctest_list.txt
                else
                    touch test_preparation/doctest_list.txt
                fi
Sylvain Gugger's avatar
Sylvain Gugger committed
58
59
60
61
62
63
64
            - run: |
                if [ -f test_repo_utils.txt ]; then
                    mv test_repo_utils.txt test_preparation/test_repo_utils.txt
                else
                    touch test_preparation/test_repo_utils.txt
                fi
            - run: python utils/tests_fetcher.py --filter_tests
65
66
67
68
69
70
            - run: |
                if [ -f test_list.txt ]; then
                    mv test_list.txt test_preparation/filtered_test_list.txt
                else
                    touch test_preparation/filtered_test_list.txt
                fi
71
72
            - store_artifacts:
                  path: test_preparation/test_list.txt
73
74
            - store_artifacts:
                  path: test_preparation/doctest_list.txt
75
76
            - store_artifacts:
                  path: ~/transformers/test_preparation/filtered_test_list.txt
77
            - store_artifacts:
78
79
                  path: test_preparation/examples_test_list.txt
            - run: python .circleci/create_circleci_config.py --fetcher_folder test_preparation
80
            - run: |
81
82
83
84
85
86
87
                  if [ ! -s test_preparation/generated_config.yml ]; then
                      echo "No tests to run, exiting early!"
                      circleci-agent step halt
                  fi
            - run: cp test_preparation/generated_config.yml test_preparation/generated_config.txt
            - store_artifacts:
                  path: test_preparation/generated_config.txt
Yih-Dar's avatar
Yih-Dar committed
88
89
            - store_artifacts:
                  path: test_preparation/filtered_test_list_cross_tests.txt
90
91
            - continuation/continue:
                  configuration_path: test_preparation/generated_config.yml
92

Sylvain Gugger's avatar
Sylvain Gugger committed
93
94
95
96
    # To run all tests for the nightly build
    fetch_all_tests:
        working_directory: ~/transformers
        docker:
97
            - image: cimg/python:3.8.12
Sylvain Gugger's avatar
Sylvain Gugger committed
98
99
        parallelism: 1
        steps:
100
            - checkout
101
            - run: pip install --upgrade pip
ydshieh's avatar
ydshieh committed
102
            - run: pip install GitPython
103
            - run: pip install .
Sylvain Gugger's avatar
Sylvain Gugger committed
104
105
            - run: |
                  mkdir test_preparation
Yih-Dar's avatar
Yih-Dar committed
106
                  echo -n "tests" > test_preparation/test_list.txt
107
                  echo -n "all" > test_preparation/examples_test_list.txt
Yih-Dar's avatar
Yih-Dar committed
108
109
110
111
112
                  echo -n "tests/repo_utils" > test_preparation/test_repo_utils.txt
            - run: |
                  echo -n "tests" > test_list.txt
                  python utils/tests_fetcher.py --filter_tests
                  mv test_list.txt test_preparation/filtered_test_list.txt
113
114
            - run: python .circleci/create_circleci_config.py --fetcher_folder test_preparation
            - run: cp test_preparation/generated_config.yml test_preparation/generated_config.txt
115
            - store_artifacts:
116
117
118
                  path: test_preparation/generated_config.txt
            - continuation/continue:
                  configuration_path: test_preparation/generated_config.yml
119

Aymeric Augustin's avatar
Aymeric Augustin committed
120
121
122
    check_code_quality:
        working_directory: ~/transformers
        docker:
123
            - image: cimg/python:3.8.12
Lysandre's avatar
Lysandre committed
124
        resource_class: large
125
126
        environment:
            TRANSFORMERS_IS_CI: yes
127
            PYTEST_TIMEOUT: 120
Aymeric Augustin's avatar
Aymeric Augustin committed
128
129
130
        parallelism: 1
        steps:
            - checkout
131
132
            - restore_cache:
                  keys:
133
134
                      - v0.6-code_quality-{{ checksum "setup.py" }}
                      - v0.6-code-quality
135
            - run: pip install --upgrade pip
136
            - run: pip install .[all,quality]
137
            - save_cache:
Yih-Dar's avatar
Yih-Dar committed
138
                  key: v0.5-code_quality-{{ checksum "setup.py" }}
139
140
                  paths:
                      - '~/.cache/pip'
141
142
143
144
145
            - run:
                name: Show installed libraries and their versions
                command: pip freeze | tee installed.txt
            - store_artifacts:
                  path: ~/transformers/installed.txt
146
147
            - run: black --check examples tests src utils
            - run: ruff examples tests src utils
Sylvain Gugger's avatar
Sylvain Gugger committed
148
            - run: python utils/custom_init_isort.py --check_only
149
            - run: python utils/sort_auto_mappings.py --check_only
150
            - run: doc-builder style src/transformers docs/source --max_len 119 --check_only --path_to_docs docs/source
Sylvain Gugger's avatar
Sylvain Gugger committed
151
            - run: python utils/check_doc_toc.py
152

153
    check_repository_consistency:
R茅mi Louf's avatar
R茅mi Louf committed
154
155
        working_directory: ~/transformers
        docker:
156
            - image: cimg/python:3.8.12
Sylvain Gugger's avatar
Sylvain Gugger committed
157
158
159
        resource_class: large
        environment:
            TRANSFORMERS_IS_CI: yes
160
            PYTEST_TIMEOUT: 120
R茅mi Louf's avatar
R茅mi Louf committed
161
162
163
        parallelism: 1
        steps:
            - checkout
Sylvain Gugger's avatar
Sylvain Gugger committed
164
165
            - restore_cache:
                  keys:
166
167
                      - v0.6-repository_consistency-{{ checksum "setup.py" }}
                      - v0.6-repository_consistency
Sylvain Gugger's avatar
Sylvain Gugger committed
168
169
170
            - run: pip install --upgrade pip
            - run: pip install .[all,quality]
            - save_cache:
Yih-Dar's avatar
Yih-Dar committed
171
                  key: v0.5-repository_consistency-{{ checksum "setup.py" }}
Sylvain Gugger's avatar
Sylvain Gugger committed
172
173
                  paths:
                      - '~/.cache/pip'
174
175
176
177
178
            - run:
                name: Show installed libraries and their versions
                command: pip freeze | tee installed.txt
            - store_artifacts:
                  path: ~/transformers/installed.txt
Sylvain Gugger's avatar
Sylvain Gugger committed
179
180
181
182
183
            - run: python utils/check_copies.py
            - run: python utils/check_table.py
            - run: python utils/check_dummies.py
            - run: python utils/check_repo.py
            - run: python utils/check_inits.py
184
            - run: python utils/check_config_docstrings.py
185
            - run: python utils/check_config_attributes.py
186
            - run: python utils/check_doctest_list.py
Sylvain Gugger's avatar
Sylvain Gugger committed
187
            - run: make deps_table_check_updated
188
            - run: python utils/update_metadata.py --check-only
189
            - run: python utils/check_task_guides.py
190

191
workflows:
LysandreJik's avatar
LysandreJik committed
192
    version: 2
193
194
195
    setup_and_quality:
        when:
            not: <<pipeline.parameters.nightly>>
LysandreJik's avatar
LysandreJik committed
196
        jobs:
197
            - check_circleci_user
Aymeric Augustin's avatar
Aymeric Augustin committed
198
            - check_code_quality
199
            - check_repository_consistency
Sylvain Gugger's avatar
Sylvain Gugger committed
200
            - fetch_tests
201

202
    nightly:
203
        when: <<pipeline.parameters.nightly>>
204
        jobs:
205
            - check_circleci_user
206
207
208
            - check_code_quality
            - check_repository_consistency
            - fetch_all_tests