Skip to content

[soil] Docs vs workflow fixes from testing (testrigs validation, workflow names, Signup trigger, KUBECONFIG) - #568

Merged
bhumi46 merged 6 commits into
mosip:soilfrom
bhumi46:soil/testrigs-slack-optional
Nov 20, 2026
Merged

bhumi46 merged 6 commits into
mosip:soilfrom
bhumi46:soil/testrigs-slack-optional

Conversation

@bhumi46

@bhumi46 bhumi46 commented Nov 20, 2026 •

Copy link
Copy Markdown
Member

Refs #566

One PR for the docs-vs-workflow mismatches found during testing. Each bug is listed with its error, root cause and fix.

1. Slack channel is described as optional, but validation requires it

  • Error: helmsman_testrigs.yml → validate-inputs fails with slack_channel_name is empty — set vars.SLACK_CHANNEL_NAME … when the input and the var are both empty.
  • Docs say optional: docs/HELMSMAN_TESTRIGS_GUIDE.md, in the input table and in step (8).
  • Root cause: the channel was in the required-variables list. No testrigs-dsf.yaml uses it; the testrigs only use the SLACK_WEBHOOK_URL secret.
  • Fix: an empty value now gives a ::warning:: instead of an error, and the input description says "Optional". save_var already skips empty inputs, so a stored var is kept.

2. eSignet database port is required for other profiles

  • Error: on a mosip-platform-* profile, the form marks esignet_db_port as mandatory (required: true), and validation fails with esignet_db_port is empty ….
  • Docs say: docs/HELMSMAN_TESTRIGS_GUIDE.md describes esignet_db_port as "eSignet profile only".
  • Root cause: the input was required: true and was checked for every profile. Only esignet-standalone*/testrigs-dsf.yaml use ${esignet_db_port}.
  • Fix:
    • The input is now required: false, with a description that says esignet-standalone only.
    • The check runs only when the profile is esignet-standalone*, or on a push event (push always targets that profile, as the existing mosipid_domain_name check already assumes).
  • Scope: only the testrigs workflow changes. In helmsman_esignet.yml the value stays required, because mosip-platform-*/esignet-dsf.yaml do use ${esignet_db_port}.

3. The workflow name "External + Prereqs" was not clear in the README

  • Problem: the README run-order flow and table, the docs index, and the DSF README say External + Prereqs. In the Actions tab the workflow is listed as Deploy External services of mosip using Helmsman, so the reader had to open the YAML to match them.
  • Fix: every place that uses a short name now also gives the Actions-tab name and the file:
    • README.md run-order table: new Actions tab name (workflow file) column for every step;
    • docs/README.md index;
    • docs/HELMSMAN_EXTERNAL_GUIDE.md: a "Which workflow?" note explaining why it's called External + Prereqs (one run deploys prereq-dsf.yaml and external-dsf.yaml);
    • Helmsman/dsf/README.md.

4. Signup documented as auto-triggered (found while fixing 3)

  • Problem: README.md (Signup (auto)), docs/DSF_CONFIGURATION_GUIDE.md ("auto-triggered") and docs/SECRET_GENERATION_GUIDE.md (the PAT auto-trigger) all describe Signup as starting automatically.
  • Reality: the workflow-caller job in helmsman_esignet.yml is commented out, and ESIGNET_STANDALONE_DEPLOYMENT_GUIDE.md already says it is temporarily disabled.
  • Fix: those three docs now say Signup is manual and the auto-trigger is temporarily disabled.

5. KUBECONFIG instructions should say to check whether it is set

  • Problem: README step "Configure KUBECONFIG Secret" told users to add the secret, even when the deployment had already stored it (Rancher import + PUBLISH_KUBECONFIG).
  • Fix:
    • README.md step 2 is now "Check the KUBECONFIG Secret (add it only if missing)": look under Settings → Environments → branch → Environment secrets.
      • If it's listed, skip; update it only after a cluster rebuild.
      • If not, get the kubeconfig and add it.
    • The same wording is in the README run-order summary, the verify list, and the ESIGNET_STANDALONE_DEPLOYMENT_GUIDE.md secrets table.

Also

docs/_images/workflows/helmsman_testrigs.svg was regenerated with .github/mkdocs/render_workflow_forms.py, so the docs check passes.

Backward compatibility

  • Runs that already set these values behave exactly as before.
  • Only the empty cases change: the Slack channel on any profile, and the eSignet port on mosip-platform profiles.

Testing

  • actionlint: no findings on the changed step.

  • render_workflow_forms.py --check → OK.

  • mkdocs build --strict passes (develop and soil).

  • Simulated the validation under bash -e for each case:

    Profile Port empty Port set
    push (no profile) fails ok
    esignet-standalone fails ok
    mosip-platform-1.2.1.x ok ok

🤖 Generated with Claude Code

The docs (HELMSMAN_TESTRIGS_GUIDE, workflow input help) describe the Slack
channel as optional, but helmsman_testrigs.yml failed validation when both
the slack_channel_name input and vars.SLACK_CHANNEL_NAME were empty. No
testrigs DSF uses the channel name (only the SLACK_WEBHOOK_URL secret), so
an empty value now prints a warning instead of failing. save_var already
skips empty inputs.

Signed-off-by: Bhuminathan M <thisisbn46@gmail.com>
@bhumi46 bhumi46 self-assigned this Nov 20, 2026
@coderabbitai

coderabbitai Bot commented Nov 20, 2026 •

Copy link
Copy Markdown
Contributor

Important

Review skipped

Auto reviews are disabled on base/target branches other than the default branch.

🗂️ Base branches to auto review: 17

  • ^main$
  • ^master$
  • ^master-java21$
  • ^develop$
  • ^develop2$
  • ^develop/.*
  • ^release$
  • ^release/.*
  • ^release-.*
  • ^\d+.\d+.x$
  • ^\d+.\d+.\d+$
  • ^hotfix/.*
  • ^hotfix-.*
  • ^issue-.*
  • develop
  • release-*
  • MOSIP*

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

Run configuration

  • Source mode: Auto
  • Repository: Unavailable
  • Branch: Unavailable
  • File: No configuration file from this repository applied
  • Commit: Unavailable
  • Layers: Repository UI; Enforced overrides: Organization
  • Review profile: ASSERTIVE
  • Plan: Advanced
  • Run ID: 1971759d-fc2b-4376-8e0e-b41c61a4e904

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Use the checkbox below for a quick retry:

  • Trigger review
  • Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

Share

The slack_channel_name input description changed; re-rendered with
.github/mkdocs/render_workflow_forms.py.

Signed-off-by: Bhuminathan M <thisisbn46@gmail.com>
…ofiles

The testrigs guide documents esignet_db_port as "eSignet profile only",
but the input was required: true and validation failed for
mosip-platform-* profiles too. Only the esignet-standalone* testrigs DSFs
use ${esignet_db_port}, so the input is now optional and the check runs
only for esignet-standalone* (or push events, which target that profile).
Form image regenerated.

Signed-off-by: Bhuminathan M <thisisbn46@gmail.com>
@bhumi46 bhumi46 changed the title [soil] Testrigs: make Slack channel name optional (matches docs) [soil] Testrigs workflow: align input validation with docs (Slack channel, eSignet DB port) Nov 20, 2026
… manual

"External + Prereqs" did not say which workflow to run. The README run-order
table, docs index, External guide and DSF README now give the Actions tab
name and file (Deploy External services of mosip using Helmsman,
helmsman_external.yml) next to the short name; the other steps likewise.

Signup was documented as auto-triggered, but the workflow-caller job in
helmsman_esignet.yml is commented out (ESIGNET_STANDALONE guide already says
it is temporarily disabled). README, DSF_CONFIGURATION_GUIDE and
SECRET_GENERATION_GUIDE now say manual.

Signed-off-by: Bhuminathan M <thisisbn46@gmail.com>
@bhumi46 bhumi46 changed the title [soil] Testrigs workflow: align input validation with docs (Slack channel, eSignet DB port) [soil] Docs vs workflow fixes from testing (testrigs validation, workflow names, Signup trigger) Nov 20, 2026
The README told users to configure the KUBECONFIG secret even when the
deployment had already stored it (Rancher import + PUBLISH_KUBECONFIG).
Step 2 now says to check Settings -> Environments -> <branch> first and add
it only if missing (update only after a cluster rebuild); the run-order
summary and the esignet-standalone secrets table say the same.

Signed-off-by: Bhuminathan M <thisisbn46@gmail.com>
@bhumi46 bhumi46 changed the title [soil] Docs vs workflow fixes from testing (testrigs validation, workflow names, Signup trigger) [soil] Docs vs workflow fixes from testing (testrigs validation, workflow names, Signup trigger, KUBECONFIG) Nov 20, 2026
… push

The push trigger matches every Helmsman/dsf/**/testrigs-dsf.yaml, so a
push to a mosip-platform-* testrigs DSF was validated as esignet-standalone
(empty PROFILE) and required esignet_db_port and mosipid_domain_name.
validate-inputs now checks out the repo on push and resolves PROFILE from
the changed DSF path with the same logic as the deploy job's Set Profile
step; the esignet checks are gated on esignet-standalone* only. Event
values are passed via env. (CodeRabbit review.)

Signed-off-by: Bhuminathan M <thisisbn46@gmail.com>
@bhumi46
bhumi46 marked this pull request as ready for review November 20, 2026 08:32
@bhumi46
bhumi46 merged commit b72bfa9 into mosip:soil Nov 20, 2026
5 checks passed
@ckm007

ckm007 commented Nov 20, 2026

Copy link
Copy Markdown
Member

🔗 Linked PR

@ckm007

ckm007 commented Nov 20, 2026 •

Copy link
Copy Markdown
Member

🔗 Linked PR

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants