VED-000: Update README with linting info and tests/e2e_automation/.env.example… (#1258)

* Update README with linting info and tests/e2e_automation/.env.example.dynamic with apigee env info

* Address review comments

Author: edhall-nhs

README.md

@@ -142,12 +142,22 @@ Steps:
     pip install poetry
     ```
 
-8. Install pre-commit hooks. Ensure you have installed nodejs at the same version or later as per .tool-versions and
+### Install Pre-Commit Hooks
+
+[Husky](https://typicode.github.io/husky/) is used to perform automatic checks upon making a commit.
+It is configured within `.husky/pre-commit` to run the checks defined in the root level `package.json` under `lint-staged`.
+To set this up:
+
+1. Ensure you have installed nodejs at the same version or later as per .tool-versions and
    then, from the repo root, run:
+
     ```
     npm install
     ```
 
+2. Run `cd quality_checks` then `poetry install --no-root`. This will make sure your version of ruff is the same as used in the GitHub pipeline.
+   You can check your version is correct by running `poetry run ruff --version` from within the `quality_checks` directory and comparing to the version in the poetry.lock file.
+
 ### Setting up a virtual environment with poetry
 
 The steps below must be performed in each Lambda function folder and e2e_automation folder to ensure the environment is correctly configured.
@@ -206,18 +216,6 @@ Steps:
 
 It is not necessary to activate the virtual environment (using `source .venv/bin/activate`) before running a unit test suite from the command line; `direnv` will pick up the correct configurations for us. Run `pip list` to verify that the expected packages are installed. You should for example see that `recordprocessor` is specifically running `moto` v4, regardless of which if any `.venv` is active.
 
-### Setting up the root level environment
-
-The root-level virtual environment is primarily used for linting, as we create separate virtual environments for each folder that contains Lambda functions.
-Steps:
-
-1. Follow instructions above to [install dependencies](#install-dependencies) & [set up a virtual environment](#setting-up-a-virtual-environment-with-poetry).
-   **Note: While this project uses Python 3.11 (e.g. for Lambdas), the NHSDigital/api-management-utils repository — which orchestrates setup and linting — defaults to Python 3.8.
-   The linting command is executed from within that repo but calls the Makefile in this project, so be aware of potential Python version mismatches when running or debugging locally or in the pipeline.**
-2. Run `make lint`. This will:
-    - Check the linting of the API specification yaml.
-    - Run Flake8 on all Python files in the repository, excluding files inside .venv and .terraform directories.
-
 ## IDE setup
 
 The current team uses VS Code mainly. So this setup is targeted towards VS code. If you use another IDE please add the documentation to set up workspaces here.

tests/e2e_automation/.env.example.dynamic

@@ -11,14 +11,16 @@ scope=
 # Set all the below values based on the environment you are testing e.g. pr-xxx, internal-dev, internal-qa
 baseUrl=https://internal-dev.api.service.nhs.uk/immunisation-fhir-api/FHIR/R4-pr-123
 aws_token_refresh=False
-aws_profile_name={your-aws-profile}
+aws_profile_name=your-aws-profile# e.g. 345594581768_DEV-IMMS-Devops
 
 S3_env=pr-123
 LOCAL_RUN_FILE_NAME=HPV_Vaccinations_v5_V0V8L_20251111T16304982.csv
 AWS_DOMAIN_NAME=pr-123.imms.dev.vds.platform.nhs.uk
 
 PROXY_NAME=immunisation-fhir-api-pr-123
 # See README for details on how to obtain this
-APIGEE_ACCESS_TOKEN={use-the-apigee-get-token-utility}
-APIGEE_USERNAME={your-apigee-developer-email}
-APIGEE_ENVIRONMENT={the-relevant-apigee-env}# E.g. internal-dev, internal-qa
+APIGEE_ACCESS_TOKEN=use-the-apigee-get-token-utility-and-paste-token-here
+APIGEE_USERNAME=forename.surname1@nhs.net
+# E.g. internal-dev, internal-qa for running the e2e test locally. Refer to manifest_template.yml in the root directory
+# to see the defined apigee environments. Note: use internal-dev (i.e. NOT pr-123) for testing your PR locally
+APIGEE_ENVIRONMENT=internal-dev