added comments to actions and workflows

Author: scarlehoff

.github/actions/install_conda_pip/action.yml

@@ -1,5 +1,24 @@
 name: Install nnpdf using pip under a conda environment
 
+# This composite action installs NNPDF using pip
+# under a conda environment which is used to install lhapdf and pandoc
+# see https://docs.github.com/en/actions/sharing-automations/creating-actions/creating-a-composite-action
+
+# Use it as a step of your workflow as:
+# - uses: ./.github/actions/install_conda_pip
+#
+# It is possible to modify the python version of the default environment with
+#         with:
+#           python-version: "3.12"
+#
+# And the extras to be installed with. The string nnpdf-extras will be passed to pip directly.
+#         with:
+#           nnpdf-extras: "[qed,tests]"
+#
+# Remember that these actions are only available after checking out the repository,
+# which should always be the first step!
+# - uses: actions/checkout@v4
+
 inputs:
   python-version:
     required: true

.github/actions/prepare_environment/action.yml

@@ -1,4 +1,19 @@
-name: Prepare environment
+name: Prepare a conda environment for NNPDF installation
+
+# This composite action prepares a conda environment with a set of shared settings
+# that all NNPDF workflows should utilize.
+# see https://docs.github.com/en/actions/sharing-automations/creating-actions/creating-a-composite-action
+
+# Use it as a step of your workflow as:
+# - uses: ./.github/actions/install_conda_pip
+#
+# It is possible to modify the python version of the default environment with
+#         with:
+#           python-version: "3.12"
+#
+# Remember that these actions are only available after checking out the repository,
+# which should always be the first step!
+# - uses: actions/checkout@v4
 
 inputs:
   python-version:
@@ -16,7 +31,7 @@ runs:
         channels: https://packages.nnpdf.science/public,conda-forge
         show-channel-urls: true
         auto-update-conda: true
-        activate-environment: test
+        activate-environment: nnpdf_environment
         conda-remove-defaults: true
     - name: Add NETRC
       shell: bash -l {0}

.github/workflows/all_tests_nnpdf.yml

@@ -1,5 +1,9 @@
 name: All tests NNPDF
 
+# This workflow collects all tests for the NNPDF framework
+# the environment and installation steps are shared as they are using
+# the custom actions in .github/actions/
+
 on: [push]
 
 env:
@@ -16,7 +20,7 @@ jobs:
         include:
           - os: ubuntu-latest
             CONDA_OS: linux-64
-      fail-fast: false
+      fail-fast: false # continue even if some jobs failed
     runs-on: ${{ matrix.os }}
     steps:
       - uses: actions/checkout@v4
@@ -46,7 +50,7 @@ jobs:
     runs-on: ${{ matrix.os }}
     steps:
       - uses: actions/checkout@v4
-        with:
+        with: # conda requires fetching the history of the repo to prepare the package name
           fetch-tags: true
           fetch-depth: 0
       - uses: ./.github/actions/prepare_environment