Skip to content

Clarified 'enable_terminal' workflow_dispatch label.#2504

Open
AlexSkrypnyk wants to merge 2 commits into
mainfrom
feature/ci-terminal-label
Open

Clarified 'enable_terminal' workflow_dispatch label.#2504
AlexSkrypnyk wants to merge 2 commits into
mainfrom
feature/ci-terminal-label

Conversation

@AlexSkrypnyk
Copy link
Copy Markdown
Member

@AlexSkrypnyk AlexSkrypnyk commented May 21, 2026

Summary

The enable_terminal workflow_dispatch input had a generic label ("Enable terminal session") that did not make clear it applies specifically to CI jobs rather than a local or general-purpose terminal. The label has been updated to "Enable terminal session for CI jobs" to eliminate that ambiguity. The corresponding docs paragraph has been updated to match.

Changes

Workflow file (.github/workflows/build-test-deploy.yml):

  • Renamed enable_terminal.description from 'Enable terminal session' to 'Enable terminal session for CI jobs'

Documentation (.vortex/docs/content/continuous-integration/github-actions.mdx):

  • Updated the "Terminal access for debugging" paragraph to refer to the new label text

Snapshot fixtures (auto-regenerated):

  • .vortex/installer/tests/Fixtures/handler_process/_baseline/.github/workflows/build-test-deploy.yml
  • .vortex/installer/tests/Fixtures/handler_process/provision_profile/.github/workflows/build-test-deploy.yml

Before / After

The label shown in the GitHub Actions "Run workflow" form:

Before:
  Enable terminal session   [ ]

After:
  Enable terminal session for CI jobs   [ ]

Docs paragraph (before):

run with the Enable terminal session option checked to get SSH connection
details in the build logs.

Docs paragraph (after):

run with the Enable terminal session for CI jobs option checked to get SSH
connection details in the build logs.

Summary by CodeRabbit

  • Documentation

    • Updated GitHub Actions documentation to reflect clearer wording for the terminal session option.
  • Chores

    • Clarified workflow configuration description for the terminal session feature in CI jobs.

Review Change Stack

@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented May 21, 2026

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Repository UI

Review profile: ASSERTIVE

Plan: Pro Plus

Run ID: 1fe32432-9f92-45c0-bdd6-6c22674b4d17

📥 Commits

Reviewing files that changed from the base of the PR and between 0e1b569 and f1abc9b.

⛔ Files ignored due to path filters (2)
  • .vortex/installer/tests/Fixtures/handler_process/_baseline/.github/workflows/build-test-deploy.yml is excluded by !.vortex/installer/tests/Fixtures/**
  • .vortex/installer/tests/Fixtures/handler_process/provision_profile/.github/workflows/build-test-deploy.yml is excluded by !.vortex/installer/tests/Fixtures/**
📒 Files selected for processing (2)
  • .github/workflows/build-test-deploy.yml
  • .vortex/docs/content/continuous-integration/github-actions.mdx

Walkthrough

This PR clarifies the wording of the enable_terminal workflow dispatch input by explicitly stating it enables a terminal session for CI jobs, rather than using generic phrasing. The corresponding documentation is updated to reference the clarified wording consistently.

Changes

Terminal Session Documentation Clarification

Layer / File(s) Summary
Enable terminal session wording clarification
.github/workflows/build-test-deploy.yml, .vortex/docs/content/continuous-integration/github-actions.mdx
Updated the workflow_dispatch input description for enable_terminal from a generic phrase to explicitly state it enables a terminal session for CI jobs. The documentation referencing this option is updated to match the new wording.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Poem

A rabbit hops through workflows clear,
Adjusting words both far and near,
"For CI jobs" now shines so bright—
The terminal session, spelled just right! 🐰✨

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title clearly summarizes the main change: clarifying the 'enable_terminal' workflow_dispatch label to be more explicit about its purpose for CI jobs.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch feature/ci-terminal-label

Comment @coderabbitai help to get the list of available commands and usage tips.

@github-actions
Copy link
Copy Markdown

Code coverage (threshold: 90%)

  Classes: 100.00% (1/1)
  Methods: 100.00% (2/2)
  Lines:   98.53% (201/204)
Per-class coverage
Drupal\ys_demo\Plugin\Block\CounterBlock
  Methods: 100.00% ( 2/ 2)   Lines: 100.00% ( 10/ 10)

@AlexSkrypnyk

This comment has been minimized.

2 similar comments
@AlexSkrypnyk

This comment has been minimized.

@AlexSkrypnyk
Copy link
Copy Markdown
Member Author

Code coverage (threshold: 90%)

  Classes: 100.00% (1/1)
  Methods: 100.00% (2/2)
  Lines:   98.53% (201/204)
Per-class coverage
Drupal\ys_demo\Plugin\Block\CounterBlock
  Methods: 100.00% ( 2/ 2)   Lines: 100.00% ( 10/ 10)

@codecov
Copy link
Copy Markdown

codecov Bot commented May 21, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 69.56%. Comparing base (0e1b569) to head (f1abc9b).

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #2504   +/-   ##
=======================================
  Coverage   69.56%   69.56%           
=======================================
  Files          43       43           
  Lines        2602     2602           
  Branches        3        3           
=======================================
  Hits         1810     1810           
  Misses        792      792           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@AlexSkrypnyk AlexSkrypnyk enabled auto-merge (squash) May 21, 2026 23:04
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

Status: BACKLOG

Development

Successfully merging this pull request may close these issues.

1 participant