Repository navigation
[soil] Docs vs workflow fixes from testing (testrigs validation, workflow names, Signup trigger, KUBECONFIG) - #568
Merged
Conversation
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>
Contributor
|
Important Review skippedAuto reviews are disabled on base/target branches other than the default branch. 🗂️ Base branches to auto review: 17
Please check the settings in the CodeRabbit UI or the
|
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>
… 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>
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>
… 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>
Member
|
🔗 Linked PR
|
Member
|
🔗 Linked PR
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
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
helmsman_testrigs.yml→validate-inputsfails withslack_channel_name is empty — set vars.SLACK_CHANNEL_NAME …when the input and the var are both empty.docs/HELMSMAN_TESTRIGS_GUIDE.md, in the input table and in step (8).testrigs-dsf.yamluses it; the testrigs only use theSLACK_WEBHOOK_URLsecret.::warning::instead of an error, and the input description says "Optional".save_varalready skips empty inputs, so a stored var is kept.2. eSignet database port is required for other profiles
mosip-platform-*profile, the form marksesignet_db_portas mandatory (required: true), and validation fails withesignet_db_port is empty ….docs/HELMSMAN_TESTRIGS_GUIDE.mddescribesesignet_db_portas "eSignet profile only".required: trueand was checked for every profile. Onlyesignet-standalone*/testrigs-dsf.yamluse${esignet_db_port}.required: false, with a description that says esignet-standalone only.esignet-standalone*, or on a push event (push always targets that profile, as the existingmosipid_domain_namecheck already assumes).helmsman_esignet.ymlthe value stays required, becausemosip-platform-*/esignet-dsf.yamldo use${esignet_db_port}.3. The workflow name "External + Prereqs" was not clear in the README
README.mdrun-order table: new Actions tab name (workflow file) column for every step;docs/README.mdindex;docs/HELMSMAN_EXTERNAL_GUIDE.md: a "Which workflow?" note explaining why it's called External + Prereqs (one run deploysprereq-dsf.yamlandexternal-dsf.yaml);Helmsman/dsf/README.md.4. Signup documented as auto-triggered (found while fixing 3)
README.md(Signup (auto)),docs/DSF_CONFIGURATION_GUIDE.md("auto-triggered") anddocs/SECRET_GENERATION_GUIDE.md(the PAT auto-trigger) all describe Signup as starting automatically.workflow-callerjob inhelmsman_esignet.ymlis commented out, andESIGNET_STANDALONE_DEPLOYMENT_GUIDE.mdalready says it is temporarily disabled.5. KUBECONFIG instructions should say to check whether it is set
PUBLISH_KUBECONFIG).README.mdstep 2 is now "Check the KUBECONFIG Secret (add it only if missing)": look under Settings → Environments → branch → Environment secrets.ESIGNET_STANDALONE_DEPLOYMENT_GUIDE.mdsecrets table.Also
docs/_images/workflows/helmsman_testrigs.svgwas regenerated with.github/mkdocs/render_workflow_forms.py, so the docs check passes.Backward compatibility
Testing
actionlint: no findings on the changed step.render_workflow_forms.py --check→ OK.mkdocs build --strictpasses (develop and soil).Simulated the validation under
bash -efor each case:esignet-standalonemosip-platform-1.2.1.x🤖 Generated with Claude Code