Skip to content

Commit 31ac6e5

Browse files
authored
Add documentation on python-environment GithubAction (#177)
1 parent 9b827b2 commit 31ac6e5

File tree

3 files changed

+50
-0
lines changed

3 files changed

+50
-0
lines changed

doc/changes/unreleased.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,7 @@ For additional information, refer to [customization](../user_guide/customization
1212

1313
## 📚 Documentation
1414
* Added documentation on nox task plugins for users and developers.
15+
* Added documentation on python-environment action.
1516
* Updated theme and structure of the documentation.
1617

1718
## 🔩 Internal

doc/github_actions/github_actions.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,4 +6,5 @@
66
.. toctree::
77
:maxdepth: 2
88

9+
python_environment
910
security_issues
Lines changed: 48 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,48 @@
1+
python-environment
2+
==================
3+
This action prepares everything related to Python for the project to run or to be tested. It involves installing the Python interpreter and Poetry. It also includes creating and activating a Poetry environment, as well as installing the project dependencies, and the project itself, into the Poetry environment.
4+
5+
Parameters
6+
----------
7+
.. list-table::
8+
:header-rows: 1
9+
10+
* - Parameter
11+
- Description
12+
- Required
13+
- Default
14+
* - python-version
15+
- Python version to use
16+
- True
17+
- 3.8
18+
* - poetry-version
19+
- Poetry version to use
20+
- True
21+
- 1.2.2
22+
23+
Example Usage
24+
-------------
25+
26+
.. code-block:: yaml
27+
28+
name: Checks
29+
30+
...
31+
32+
jobs:
33+
34+
test-job:
35+
name: Tests
36+
runs-on: ubuntu-latest
37+
38+
steps:
39+
- name: SCM Checkout
40+
uses: actions/checkout@v3
41+
42+
- name: Setup Python & Poetry Environment
43+
uses: exasol/python-toolbox/.github/actions/python-environment@0.9.0
44+
with:
45+
python-version: 3.12
46+
poetry-version: 1.2.2
47+
48+
...

0 commit comments

Comments
 (0)