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
13 changes: 7 additions & 6 deletions docs/source/release_process.rst
Original file line number Diff line number Diff line change
Expand Up @@ -26,10 +26,10 @@ Follow these steps to create a release:

- 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.
and push the tag. This triggers the GitHub Actions workflow for build and deploy.

- No special permissions for pypi.org are required. Travis has access
to a token which grants permission to publish to `pypi.org`.
- After GitHub Actions is added as a trusted publisher in PyPI, short lived API tokens
will be generated that automate the release process and publish to `pypi.org`.

.. code-block:: shell

Expand All @@ -38,8 +38,9 @@ Follow these steps to create a release:
$ git tag -a rel/$VERSION -m "Tagging release $VERSION"
$ git push --tags

- A new build for the tag should appear on `Travis`_. Once the *deploy* stage
has run successfully, the new version should be available on `pypi.org`_.
- A new run of the CI workflow for the tag should appear on `GitHub Actions`_. Once the
*deploy* stage 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 *main* on any update
Expand All @@ -51,5 +52,5 @@ Follow these steps to create a release:
.. _pypi.org: https://pypi.org/project/data-attribute-recommendation-sdk/
.. _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
.. _GitHub Actions: https://github.com/SAP/data-attribute-recommendation-python-sdk/actions
.. _Read The Docs: https://data-attribute-recommendation-python-sdk.readthedocs.io/
12 changes: 6 additions & 6 deletions docs/source/traceability.rst
Original file line number Diff line number Diff line change
Expand Up @@ -17,12 +17,12 @@ Hence, a test evaluation report traces requirements to tests to test execution a
is thus also called a **Traceability Report**.

The reports are generated during ::`release_process<release builds>`
on Travis. Once all tests have passed successfully, the report is published
as an artifact on the `Github release page`_ for the corresponding version
of the SDK.
on GitHub Actions workflow. Once all tests have passed successfully, the report
is published as an artifact on the `Github release page`_ for the corresponding
version of the SDK.

If the build on Travis is not successful, no artifact is uploaded to Pypi and also
no test evaluation report is uploaded.
If the jobs on GitHub Actions workflow is not successful, no artifact is
uploaded to Pypi and also no test evaluation report is uploaded.

.. _Github release page: https://github.com/SAP/data-attribute-recommendation-python-sdk/releases

Expand Down Expand Up @@ -106,7 +106,7 @@ Issues Tests

The test evaluation report is only generated when using pytest's html output. This
requires the ``pytest-html`` plugin and use the ``--html`` option when calling pytest.
On Travis, this is handled via `tox`_.
On GitHub Actions, this is handled via `tox`_.

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

Expand Down