github / github/version_sorter

Please define actions workflow permissions

Open
#31 0 comments 0 reactions 0 assignees View on GitHub
Dominant language
C
Stars
130
Forks
35
PR merge metrics
No merged PRs in 30d

Description

## Workflow permissions improvement

There are **1 workflow file** that are currently lacking explicit permissions

### Affected Workflow Files

The following workflow files need permissions to be explicitly defined:

- [`.github/workflows/test.yml`](https://github.com/github/version_sorter/blob/main/.github/workflows/test.yml)

### Request

Ensure permissions are explicitly defined. Below are Copilot prompts/instructions if you would like Copilot's assistance with addressing this.

## GitHub Copilot Assignment Prompts and Context

**Task**: Add explicit permissions to GitHub Actions workflow files that are currently missing them.

**Scope**: Update the workflow files listed above to include appropriate `permissions:` blocks.

**Analysis Methodology**:
1. **Gather Current State**: Check if the workflow has any existing permissions defined
2. **Inventory Workflow Actions**:
- Actions performed directly by the workflow
- API calls made by the workflow
- External actions included via `uses:` statements
3. **Determine Required Permissions**: Map each action to its minimum required permissions
4. **Synthesize Minimal Permissions**: Create permissions block with only necessary permissions

**Requirements**:
1. Add a `permissions:` block to each workflow file that doesn't have one
2. Start with `contents: read` as the minimum permission
3. Add additional permissions only if the workflow actually needs them based on the actions it performs
4. Place the `permissions:` block at the job level or workflow level as appropriate
5. Ensure the syntax is correct and follows YAML formatting
6. Maintain existing content formatting, including indentation and comments

**Files to modify**: See the list of affected workflow files above.

**Acceptance criteria**:
- [ ] All listed workflow files have explicit permissions defined
- [ ] Permissions follow the principle of least privilege
- [ ] YAML syntax is valid
- [ ] Workflows still function correctly after changes

## Copilot Instructions:

Please create a pull request that adds appropriate `permissions:` blocks to each of the workflow files listed above. Analyze each workflow to determine the minimum permissions required based on the actions it performs, and add only those necessary permissions.

Contributor guide

Open the contributing guide

Research direction

Start by reading .github/workflows/test.yml and inventorying the actions and steps it uses. Add a workflow- or job-level permissions block with the minimum required access, then validate the YAML and confirm the workflow still functions.

Written by the indexing model from the issue text.

Assessment

Tech stack
github-actions
Domain
ci-cd, security
Issue type
Feature
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
58/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.