Skip to content

Commit

Permalink
Merge pull request #509 from Epistimio/release-0.1.11rc
Browse files Browse the repository at this point in the history
Release candidate 0.1.11rc
  • Loading branch information
bouthilx authored Dec 4, 2020
2 parents d35324f + 5b3a890 commit af4a565
Show file tree
Hide file tree
Showing 200 changed files with 14,404 additions and 10,115 deletions.
71 changes: 0 additions & 71 deletions .flake8

This file was deleted.

36 changes: 36 additions & 0 deletions .github/release-drafter.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
name-template: 'v$RESOLVED_VERSION'
tag-template: 'v$RESOLVED_VERSION'
categories:
- title: '🚀 Features'
labels:
- 'feature'
- 'enhancement'
- title: '🐛 Bug Fixes'
labels:
- 'fix'
- 'bugfix'
- 'bug'
- title: '📜 Documentation'
labels:
- 'documentation'
- title: '🧰 Maintenance'
labels:
- 'ci'
change-template: '- $TITLE @$AUTHOR (#$NUMBER)'
change-title-escapes: '\<*_&' # You can add # and @ to disable mentions, and add ` to disable code blocks.
version-resolver:
major:
labels:
- 'major'
minor:
labels:
- 'minor'
patch:
labels:
- 'patch'
default: patch
template: |
## Changes
$CHANGES
4 changes: 2 additions & 2 deletions .github/workflows/build.yml
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ jobs:
runs-on: ubuntu-latest
strategy:
matrix:
toxenv: [flake8, pylint, doc8, docs]
toxenv: [black, isort, pylint, doc8, docs]

steps:
- uses: actions/checkout@v1
Expand All @@ -38,7 +38,7 @@ jobs:
max-parallel: 4
matrix:
platform: [ubuntu-latest]
python-version: [3.6, 3.7, 3.8]
python-version: [3.6, 3.7, 3.8, 3.9]
env:
PLATFORM: ${{ matrix.platform }}
steps:
Expand Down
27 changes: 27 additions & 0 deletions .github/workflows/release-drafter.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
name: Release Drafter

on:
push:
branches:
- develop

jobs:
update_release_draft:
runs-on: ubuntu-latest
steps:
# Drafts your next Release notes as Pull Requests are merged into "master"
- uses: release-drafter/release-drafter@v5
id: drafter
# with:
# (Optional) specify config name to use, relative to .github/. Default: release-drafter.yml
# config-name: my-config.yml
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
- name: Check outputs
run: |
echo "Release ID - ${{ steps.drafter.outputs.id }}"
echo "Release name - ${{ steps.drafter.outputs.name }}"
echo "Release tag name - ${{ steps.drafter.outputs.tag_name }}"
echo "Release body - ${{ steps.drafter.outputs.body }}"
echo "Release html url - ${{ steps.drafter.outputs.html_url }}"
echo "Release upload url - ${{ steps.drafter.outputs.upload_url }}"
2 changes: 1 addition & 1 deletion .pylintrc
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@ confidence=
# no Warning level messages displayed, use"--disable=all --enable=classes
# --disable=W"
disable=abstract-class-instantiated,useless-super-delegation,no-member,keyword-arg-before-vararg,unidiomatic-typecheck,redefined-outer-name,fixme,F0401,intern-builtin,wrong-import-position,wrong-import-order,
C0415, F0010, R0205, R1705, R1711, R1720, W0106, W0107, W0127, W0706
C0415, F0010, R0205, R1705, R1711, R1720, W0106, W0107, W0127, W0706, C0330, C0326

# Enable the message, report, category or checker with the given id(s). You can
# either give multiple identifier separated by comma (,) or put this option
Expand Down
1 change: 0 additions & 1 deletion MANIFEST.in
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,6 @@ include versioneer.py
exclude tox.ini
exclude *-requirements.txt
exclude .pylintrc
exclude .flake8
exclude codecov.yml
exclude .mailmap
prune conda/
Expand Down
2 changes: 1 addition & 1 deletion README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -124,7 +124,7 @@ If you use Oríon for published work, please cite our work using the following b
month = nov,
year = 2020,
publisher = {Zenodo},
version = {v0.1.9},
version = {v0.1.11},
doi = {10.5281/zenodo.3478592},
url = {https://doi.org/10.5281/zenodo.3478592}
}
Expand Down
7 changes: 4 additions & 3 deletions ROADMAP.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,13 @@
# Roadmap
Last update February 25th, 2020
Last update December 3rd, 2020

## Next releases - Short-Term
### v0.1.10

### v0.1.12

#### Quick release for bug fixes

### v0.1.11
### v0.1.13

#### Default database backend
PickledDB will become the default database backend instead of MongoDB. This initiative reduces
Expand Down
1 change: 1 addition & 0 deletions conda/ci_build.sh
Original file line number Diff line number Diff line change
Expand Up @@ -18,3 +18,4 @@ conda install conda-build anaconda-client
conda build conda --python 3.6
conda build conda --python 3.7
conda build conda --python 3.8
conda build conda --python 3.9
1 change: 1 addition & 0 deletions conda/meta.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,7 @@ requirements:
- falcon
- gunicorn
- scikit-learn
- psutil

test:
import:
Expand Down
5 changes: 3 additions & 2 deletions docs/src/developer/ci.rst
Original file line number Diff line number Diff line change
Expand Up @@ -16,8 +16,9 @@ the repository level.
When a commit is pushed in a pull request, a github workflow is spawned which
triggers the following chain of events:

#. Code styles verifications, and quality checks are run (``flake8``, ``pylint``, ``doc8``). The
documentation is also built at this time (``docs``).
#. Code styles verifications, and quality checks are run
(``black``, ``isort``, ``pylint``, ``doc8``).
The documentation is also built at this time (``docs``).
#. When code style verifications and documentation built passes, a test environment is spun up for
each version of python tested (defined in ``.github/workflows/build.yml``).
#. The test suite is run completely with coverage, including the dedicated backward
Expand Down
4 changes: 2 additions & 2 deletions docs/src/developer/release.rst
Original file line number Diff line number Diff line change
Expand Up @@ -22,8 +22,8 @@ such as the README.rst.
category. Example: https://github.com/Epistimio/orion/pull/283.
#. Update the **Citation** section in the project's README.rst with the latest version of Oríon.
#. Update the ``ROADMAP.md``.
#. Update the linters ``flake8``, ``pylint``, and ``doc8`` to their latest versions in ``tox.ini``,
and address any new error.
#. Update the linters ``black``, ``isort``, ``pylint``, and ``doc8`` to their latest versions in
``tox.ini``, and address any new error.
#. Run the stress tests according to the instructions in stress test's documentation.

.. _release-make:
Expand Down
13 changes: 8 additions & 5 deletions docs/src/developer/standards.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,16 +6,18 @@ In this chapter, we present the different standards and guidelines we use throug
All the conventions are enforced automatically during the PR process.

You can verify if your code will pass the checks locally beforehand using ``$ tox -e lint`` (which
is the equivalent of ``$ tox -e flake8,pylint,doc8,packaging``).
is the equivalent of ``$ tox -e black,isort,pylint,doc8,packaging``).

.. _standard-coding:

Coding standard
===============

Our coding standards are specified via flake8_ and pylint_. Their configurations are provided in
``tox.ini`` and ``.pylintrc`` respectively. You can verify the conformity of your changes locally
by running ``$ tox -e flake8`` and ``$ tox -e pylint``.
Our coding standards are specified via black_, isort_ and pylint_. Their configurations are provided
in ``tox.ini`` and ``.pylintrc`` respectively. You can verify the conformity of your changes locally
by running ``$ tox -e black``, ``$ tox -e isort`` and ``$ tox -e pylint``. There is also 2 tox
commands provided to help fix black and isort issues; ``$ tox -e run-black`` and
``$ tox -e run-isort``.

In addition, we follow `Numpy's docstring standards
<https://numpydoc.readthedocs.io/en/latest/format.html#docstring-standard>`_ to ensure a good
Expand Down Expand Up @@ -222,8 +224,9 @@ No action needed or possible. The issue is either fixed, addressed
.. _invalid: https://github.com/Epistimio/orion/labels/invalid

.. _Github: https://github.com
.. _flake8: http://flake8.pycqa.org/en/latest/
.. _doc8: https://pypi.org/project/doc8/
.. _black: https://black.readthedocs.io/en/stable/
.. _isort: https://pycqa.github.io/isort/
.. _pylint: https://www.pylint.org/
.. _check-manifest: https://pypi.org/project/check-manifest/
.. _readme_renderer: https://pypi.org/project/readme_renderer/
Expand Down
Loading

0 comments on commit af4a565

Please sign in to comment.