From adec537ff99005de2cd92a27ee778f97d6fb027e Mon Sep 17 00:00:00 2001 From: Nanda Date: Wed, 26 Feb 2025 14:14:47 +0530 Subject: [PATCH 1/2] Minor documentation updatations as migrating from Travis to GitHub Actions --- docs/source/release_process.rst | 10 +++++----- docs/source/traceability.rst | 2 +- 2 files changed, 6 insertions(+), 6 deletions(-) diff --git a/docs/source/release_process.rst b/docs/source/release_process.rst index ecce3b2..b82cac9 100644 --- a/docs/source/release_process.rst +++ b/docs/source/release_process.rst @@ -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 @@ -38,7 +38,7 @@ 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 +- A new build 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 @@ -51,5 +51,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/ diff --git a/docs/source/traceability.rst b/docs/source/traceability.rst index 3adaaff..f99bbd3 100644 --- a/docs/source/traceability.rst +++ b/docs/source/traceability.rst @@ -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 From b7b70c0e61f6f2eabd518ae4994c7ec41d01e829 Mon Sep 17 00:00:00 2001 From: Nanda Date: Wed, 26 Feb 2025 15:29:14 +0530 Subject: [PATCH 2/2] minor modifications --- docs/source/release_process.rst | 5 +++-- docs/source/traceability.rst | 10 +++++----- 2 files changed, 8 insertions(+), 7 deletions(-) diff --git a/docs/source/release_process.rst b/docs/source/release_process.rst index b82cac9..7fdfa01 100644 --- a/docs/source/release_process.rst +++ b/docs/source/release_process.rst @@ -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 `GitHub Actions`_. 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 diff --git a/docs/source/traceability.rst b/docs/source/traceability.rst index f99bbd3..7bbd473 100644 --- a/docs/source/traceability.rst +++ b/docs/source/traceability.rst @@ -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` -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