Update README.md by nodeselector · Pull Request #57 · github/gh-actions-lock · GitHub
Skip to content

Update README.md - #57

Merged
nodeselector merged 6 commits into
mainfrom
nodeselector-patch-2
Jun 17, 2026
Merged

nodeselector merged 6 commits into
mainfrom
nodeselector-patch-2

Conversation

@nodeselector

@nodeselector nodeselector commented Jun 16, 2026 •

Copy link
Copy Markdown
Collaborator

✨ rendered ✨

Copilot AI review requested due to automatic review settings June 16, 2026 18:09
GitHub Advanced Security started work on behalf of nodeselector June 16, 2026 18:10
GitHub Advanced Security finished work on behalf of nodeselector June 16, 2026 18:12

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

⚠️ Not ready to approve

The updated README introduces multiple readability/grammar issues and removes documentation for environment variables that are still used in the codebase.

Pull request overview

Updates the project README to change the positioning/usage guidance and to rewrite the “How it works” and “Limitations” documentation for gh-actions-lock.

Changes:

  • Rewords the short description and streamlines the Usage section to focus on when to rerun gh actions-lock.
  • Replaces the previous detailed “How it works” explanation with a condensed prose description.
  • Adds a new “Limitations” section and removes the “Environment variables” section.
File summaries
File Description
README.md Rewrites usage and implementation documentation; adds limitations and removes environment variable docs.

Copilot's findings

Comments suppressed due to low confidence (1)

README.md:52

  • The README removed the environment-variable documentation, but these variables are still used in the codebase (e.g., GH_ACTIONS_LOCK_WORKFLOWS_DIR in cmd/gh-actions-lock/root.go and KEEP_FIXTURES/GH_TOKEN in the integration harness). Re-adding this section will help contributors run tests and debug locally.
  • Files reviewed: 1/1 changed files
  • Comments generated: 2

Note

Your feedback helps us improve the quality of this feature.
Please use 👍 or 👎 to tell us whether this assessment is correct.


💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread README.md Outdated
Q -- yes --> Plan
Lock --> Report
```
A repo gets a lockfile (located at [`.github/workflows/actions.lock`](https://github.com/github/gh-actions-lock/blob/main/.github/workflows/actions.lock)) and workflows are onboarded to the lockfile on a per-workflow basis. Workflows that are onboarded to the lockfile enforce that all dependencies are present in the lockfile and guarantees that the locked commit for an Action is what's executed on the runner. Lockfiles are also verified for forgeries - the sha must actually exist in the refs it's stated to exist in. Repository identity is recorded and redirects and mismatches are blocked at runtime. Finally, locked actions must have a branch that the commit being locked exists within - this is to make impostor commit style attacks harder.
Comment thread README.md Outdated
Comment on lines +30 to +32
GitHub Advanced Security started work on behalf of nodeselector June 16, 2026 18:20
GitHub Advanced Security finished work on behalf of nodeselector June 16, 2026 18:21
Comment thread README.md Outdated
Comment thread README.md
Co-authored-by: Steve-Glass <84886334+Steve-Glass@users.noreply.github.com>
GitHub Advanced Security started work on behalf of nodeselector June 17, 2026 14:19
GitHub Advanced Security started work on behalf of nodeselector June 17, 2026 14:20
GitHub Advanced Security started work on behalf of nodeselector June 17, 2026 14:20
GitHub Advanced Security finished work on behalf of nodeselector June 17, 2026 14:21
GitHub Advanced Security started work on behalf of nodeselector June 17, 2026 14:22
GitHub Advanced Security finished work on behalf of nodeselector June 17, 2026 14:22
GitHub Advanced Security finished work on behalf of nodeselector June 17, 2026 14:22
GitHub Advanced Security finished work on behalf of nodeselector June 17, 2026 14:23
@nodeselector
nodeselector merged commit f19e2d5 into main Jun 17, 2026
10 checks passed
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