SSWConsulting / SSWConsulting/SSW.Tiger

♻️ Tiger CI - Test suite never runs in CI, and the transcript hub prerequisites are undocumented

Open
#158 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
JavaScript
Stars
1
Forks
1
Avg merge
2d 12h
Merged PRs (30d)
2

Description

Cc: @yaqi-lyu @suiyangqiu
Hi Team!

Pain

The transcript hub fix added a test that fails when a variable set on the Container App Job goes missing from the job-start override. Neither CI workflow runs any tests, so it only fires when someone runs it by hand. That is the exact class of bug it exists to catch.

The prerequisites for that fix are undocumented too. README-AUTOMATION lists the job env vars, but not that the three plain hub settings must also exist on the Function App, which is the side the override reads them from. Nor that deploying with the hub repo set makes the Key Vault private key a hard prerequisite of the deploy rather than just switching publishing off.

Approach
  • Run the test suite in CI on pull requests
  • Pin a Node version that expands the test globs, and fail the step when 0 tests ran
  • Document both hub prerequisites, including that the private key secret name is uppercase on purpose
Acceptance Criteria
  1. A PR that drops a job variable from the override goes red in CI
  2. A run that matches no test files fails instead of passing
  3. Someone can set transcript publishing up from the docs alone
Related

https://github.com/SSWConsulting/SSW.Tiger/issues/156
https://github.com/SSWConsulting/SSW.Tiger/pull/157#discussion_r3945866170
https://github.com/SSWConsulting/SSW.Tiger/pull/157#discussion_r3945866172

Thanks!

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by locating both CI workflows and README-AUTOMATION, then inspect the existing transcript hub test and its test globs. Run the suite locally to understand the expected invocation and verify that zero matching tests fails. Done means pull requests execute the tests with a pinned Node version, missing job variables make CI fail, and the documentation covers both hub settings and the uppercase private-key secret prerequisite.

Written by the indexing model from the issue text.

Assessment

Tech stack
github-actions, javascript, node.js
Domain
ci-cd, documentation
Issue type
Feature
Difficulty
3/5
Estimated time
1-2 days
Activity status
Active
Clarity
Mostly clear
Newbie friendliness
68/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.