initial CI for discussion

Author: bhamail

.circleci/circleci-readme.md

@@ -0,0 +1,28 @@
+CI Debug Notes
+================
+To validate some circleci stuff, I was able to run a “build locally” using the steps below.
+The local build runs in a docker container.
+
+  * (Once) Install circleci client (`brew install circleci`)
+
+  * Convert the “real” config.yml into a self contained (non-workspace) config via:
+
+        circleci config process .circleci/config.yml > .circleci/local-config.yml
+
+  * Run a local build with the following command:
+          
+        circleci local execute -c .circleci/local-config.yml --job 'build'
+
+    Typically, both commands are run together:
+
+        circleci config process .circleci/config.yml > .circleci/local-config.yml && circleci local execute -c .circleci/local-config.yml --job 'build'
+
+    With the above command, operations that cannot occur during a local build will show an error like this:
+     
+      ```
+      ... Error: FAILED with error not supported
+      ```
+    
+      However, the build will proceed and can complete “successfully”, which allows you to verify scripts in your config, etc.
+      
+      If the build does complete successfully, you should see a happy green <span style="color:green">Success!</span> message.

.circleci/config.yml

@@ -0,0 +1,87 @@
+# Copyright 2019-present Sonatype Inc.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+version: 2.1
+
+executors:
+  python:
+    docker:
+      - image: circleci/python:3.7
+
+jobs:
+  publish:
+    executor: python
+    environment:
+      PIPENV_VENV_IN_PROJECT: true
+    steps:
+      - add_ssh_keys:
+          fingerprints:
+            # TODO: change fingerprint
+            - "4f:7d:6b:26:dc:44:de:b0:4d:f1:96:50:2a:b5:bd:b3"
+      - checkout
+      - run:
+          name: Setup Python environment
+          command: |
+            # TODO: do stuff, like setup venv, poetry, pip etc
+      - run:
+          command: |
+            # TODO: perform publish steps, maybe using python-semantic-release
+
+  build:
+    executor: python
+    environment:
+      PIPENV_VENV_IN_PROJECT: true
+    steps:
+      - checkout
+      - run:
+          name: Setup Python environment
+          command: |
+            # TODO: do stuff, like setup .venv, poetry, pip etc.
+      - run:
+          name: Run tests
+          command: |
+            # TODO: maybe run pylint and run those tests
+      - run:
+          name: Run self scan
+          command: |
+            # TODO: audit with jake maybe?
+      - store_test_results: # Upload test results for display in Test Summary: https://circleci.com/docs/2.0/collect-test-data/
+          path: test-results
+      - store_artifacts: # Upload test summary for display in Artifacts: https://circleci.com/docs/2.0/artifacts/
+          path: test-results
+          destination: tr1
+
+workflows:
+  version: 2
+  build_and_test_and_publish:
+    jobs:
+      - build
+#  TODO: enable to publish after successful build
+#      - publish:
+#          filters:
+#            branches:
+#              only: main
+#          context: pypi
+#          requires:
+#            - build
+
+  build_nightly:
+    triggers:
+      - schedule:
+          cron: "35 20 * * *"
+          filters:
+            branches:
+              only: main
+    jobs:
+      - build

.gitignore

@@ -0,0 +1,2 @@
+# ci config for local ci build
+/.circleci/local-config.yml