Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0

* Documentation updated to include reference to TechED 2020 workshop [#93]
* Tests: report branch coverage [#93]
* Tests: run tests with Python 3.9

[#93]: https://github.com/SAP/data-attribute-recommendation-python-sdk/pull/93

Expand Down
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ pay attention to the [CHANGELOG.md].
# Requirements

To use the SDK, you will need a recent version of Python. We actively support
and test Python ~~3.5~~ 3.6 up to Python 3.8. We aim to support all officially supported
and test Python ~~3.5~~ 3.6 up to Python 3.9. We aim to support all officially supported
Python version. This includes any Python version not
listed as `end-of-life` in the
[Python Developer's Guide](https://devguide.python.org/#branchstatus). You can check
Expand Down
2 changes: 1 addition & 1 deletion docs/source/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ Features
- Easy to use
- High-level flows on top of the basic Data Attribute Recommendation APIs
- Fully type annotated for great autocomplete experience
- Supports Python 3.6 up to 3.8 (3.5 will be removed in an upcoming release)
- Supports Python 3.6 up to 3.9 (3.5 will be removed in an upcoming release)

Release Notes
-------------
Expand Down
14 changes: 7 additions & 7 deletions docs/source/release_process.rst
Original file line number Diff line number Diff line change
Expand Up @@ -22,10 +22,10 @@ Follow these steps to create a release:
- *[Unreleased]* becomes an empty section
- Update the tag used in the URL for *[Unreleased]* to the new version number
so that *[Unreleased]* points to the changes between the new version
and whatever is pushed to master afterwards
and whatever is pushed to main afterwards

- Merge the updated `version.txt`_ and `CHANGELOG.md`_ to master
- Create a tag against the latest master with the desired version number
- Merge the updated `version.txt`_ and `CHANGELOG.md`_ to main
- Create a tag against the latest main with the desired version number
and push the tag. This triggers the build and deploy on Travis.

- No special permissions for pypi.org are required. Travis has access
Expand All @@ -42,14 +42,14 @@ Follow these steps to create a release:
has run successfully, the new version should be available on `pypi.org`_.
- The documentation on `Read The Docs`_ is automatically updated. A new version
based on the git tag is also added. Note that the default documentation version
displayed to visitors is always *latest* and is built from *master* on any update
to the *master* branch.
displayed to visitors is always *latest* and is built from *main* on any update
to the *main* branch.



.. _GitHub repository: https://github.com/SAP/data-attribute-recommendation-python-sdk
.. _pypi.org: https://pypi.org/project/data-attribute-recommendation-sdk/
.. _version.txt: https://github.com/SAP/data-attribute-recommendation-python-sdk/blob/master/version.txt
.. _CHANGELOG.md: https://github.com/SAP/data-attribute-recommendation-python-sdk/blob/master/CHANGELOG.md
.. _version.txt: https://github.com/SAP/data-attribute-recommendation-python-sdk/blob/main/version.txt
.. _CHANGELOG.md: https://github.com/SAP/data-attribute-recommendation-python-sdk/blob/main/CHANGELOG.md
.. _Travis: https://travis-ci.com/github/SAP/data-attribute-recommendation-python-sdk
.. _Read The Docs: https://data-attribute-recommendation-python-sdk.readthedocs.io/
2 changes: 1 addition & 1 deletion docs/source/support.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,4 +6,4 @@ Support

Please refer to the `main README`_.

.. _main README: https://github.com/SAP/data-attribute-recommendation-python-sdk/blob/master/README.md#how-to-obtain-support
.. _main README: https://github.com/SAP/data-attribute-recommendation-python-sdk/blob/main/README.md#how-to-obtain-support
2 changes: 1 addition & 1 deletion docs/source/traceability.rst
Original file line number Diff line number Diff line change
Expand Up @@ -108,7 +108,7 @@ The test evaluation report is only generated when using pytest's html output. Th
requires the ``pytest-html`` plugin and use the ``--html`` option when calling pytest.
On Travis, this is handled via `tox`_.

.. _tox: https://github.com/SAP/data-attribute-recommendation-python-sdk/blob/master/tox.ini
.. _tox: https://github.com/SAP/data-attribute-recommendation-python-sdk/blob/main/tox.ini

.. note::

Expand Down