CONFIG: Migrate from CirclieCI to Codefresh [DEVSECOPS-114] #234
Conversation
agrantdeakin
changed the title
codefresh.yml
Outdated
| test: | ||
| title: "Run Python tests" | ||
| type: "freestyle" # Run any command | ||
| image: "python:${{PYTHON_VERSION}}" # The image in which command will be executed |
There was a problem hiding this comment.
I'd just hard-code the Python version here rather than loading it from a project variable.
The reason for this is that if we want to upgrade to a different Python version, it's likely that there will be several other places in the repo that need to be updated (e.g. setup.py, README.md, docker-compose.yml), so we could update this at the same time with a simple find-and-replace as opposed to an additional manual step.
codefresh.yml
Outdated
| - apt-get update && apt-get install sudo -y | ||
|
|
||
| # Install surround | ||
| - sudo python setup.py install |
There was a problem hiding this comment.
| - sudo python setup.py install | |
| - python3 setup.py install |
It's generally a good idea to run python2 or python3 as opposed to python so that it's explicit which version of Python you're using.
(It's a moot point in this instance since we're using a python Docker image, but it's easier to just do it everywhere for consistency).
codefresh.yml
Outdated
| # Run tests | ||
| - sudo python setup.py test | ||
|
|
||
| # Run pylint tests | ||
| - pylint setup.py | ||
| - find surround/ -iname "*.py" | xargs pylint | ||
| - find examples/ -iname "*.py" | xargs pylint | ||
|
|
||
| # Run examples | ||
| - ls examples/ | xargs -n 1 -I '{}' python examples/'{}'/main.py |
There was a problem hiding this comment.
These three things would be good candidates for parallel steps and would speed things up considerably.
Not sure how long the build/tests actually take though, so could be outside the scope of this PR.
codefresh.yml
Outdated
| when: | ||
| branch: | ||
| only: | ||
| - master |
There was a problem hiding this comment.
Did the old CircleCI pipeline deploy to Pypi on every commit to master, or only tags?
There was a problem hiding this comment.
Like this - every time. The Pypi upload will fail if the version already exists.
There was a problem hiding this comment.
I think we can safely remove master from the when clause, because it won't work anyway if there's no tag.
Reason: git tag -l --points-at HEAD returns nothing, which makes VERSION_TAG empty, which means python3 setup.py will raise an exception.
|
Fixed Pypi config bug and addressed PR feedback. |
|
@ucokzeko Can you review this when you have a chance? |
codefresh.yml
Outdated
| approval: | ||
| title: "Pending Approval" | ||
| type: pending-approval | ||
| description: "Please approve the release to Pypi." | ||
| timeout: | ||
| duration: 2 | ||
| finalState: approved | ||
| when: | ||
| branch: | ||
| only: | ||
| - master | ||
| - /([0-9]+)\.([0-9]+)\.([0-9]+)?$/ | ||
| stage: "release" |
There was a problem hiding this comment.
I'd be inclined to remove this. Tagging the repo with a version number should be enough of a deliberate action in this case.
codefresh.yml
Outdated
| when: | ||
| branch: | ||
| only: | ||
| - master |
There was a problem hiding this comment.
I think we can safely remove master from the when clause, because it won't work anyway if there's no tag.
Reason: git tag -l --points-at HEAD returns nothing, which makes VERSION_TAG empty, which means python3 setup.py will raise an exception.
Why did I make these changes?
Future tags of this repo should remove the "v" prefix.
To do
What are the changes?
Checklist
How has this been tested?
Inline pipeline using Codefresh website