Skip to content

Add copilot-instructions.md#7

Merged
tkatrichenko merged 4 commits into
mainfrom
stas/add_copilot_instructions
Jul 8, 2025
Merged

Add copilot-instructions.md#7
tkatrichenko merged 4 commits into
mainfrom
stas/add_copilot_instructions

Conversation

@stas-sbi
Copy link
Copy Markdown
Contributor

@stas-sbi stas-sbi commented Jul 8, 2025

No description provided.

Signed-off-by: Stas German (SBI) <stasge+sbi@sbisecsol.com>
@stas-sbi stas-sbi requested a review from a team as a code owner July 8, 2025 01:40
@stas-sbi stas-sbi requested a review from Copilot July 8, 2025 01:40

This comment was marked as outdated.

Signed-off-by: Stas German (SBI) <stasge+sbi@sbisecsol.com>
@stas-sbi stas-sbi requested a review from Copilot July 8, 2025 01:47

This comment was marked as outdated.

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Signed-off-by: Stas German (SBI) <stasge+sbi@sbisecsol.com>
@stas-sbi stas-sbi requested a review from Copilot July 8, 2025 01:49
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull Request Overview

Adds a new documentation file outlining guidelines for GitHub workflows and shell scripts.

  • Specifies workflow permission settings and version pinning rules
  • Enforces use of environment variables in shell snippets
  • Requires shell scripts to pass ShellCheck
Comments suppressed due to low confidence (4)

.github/copilot-instructions.md:4

  • Clarify that in YAML this should appear as permissions: {} rather than a string literal '{}' to avoid confusion.
- permissions are set to '{}' for workflow and overridden for each job where needed

.github/copilot-instructions.md:5

  • [nitpick] Use consistent casing for GitHub and consider rephrasing to "official GitHub Actions" for clarity.
- versions of github actions are pinned to a specific commit unless the action belongs to one of: the same organization (global-synchronizer-foundation), github official actions

.github/copilot-instructions.md:6

  • [nitpick] Consider rewording to explicitly state: "In run: steps, avoid template placeholders; use environment variables instead."
- shell snippets (under `run:`) don't have templated variables and environment variables are used instead

.github/copilot-instructions.md:9

  • [nitpick] Expand this to "Shell scripts must pass ShellCheck linting without warnings" for clearer requirements.
- conforms to ShellCheck

Signed-off-by: Stas German (SBI) <stasge+sbi@sbisecsol.com>
@stas-sbi
Copy link
Copy Markdown
Contributor Author

stas-sbi commented Jul 8, 2025

@tkatrichenko would you help me to review this and then we'd run these instructions against another PR?

@tkatrichenko
Copy link
Copy Markdown
Contributor

Yeah. Let's try it with my PR

@tkatrichenko tkatrichenko merged commit d8f352e into main Jul 8, 2025
@tkatrichenko tkatrichenko deleted the stas/add_copilot_instructions branch July 8, 2025 08:03
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.

3 participants