actions / actions/toolkit

Missing github context `workspace` property

Open
#555 0 comments 5 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

bug github
Dominant language
TypeScript
Stars
5.9k
Forks
1.8k
PR merge metrics
No merged PRs in 30d

Description

Describe the bug

The github context's workspace property is not exposed from context.ts:

https://github.com/actions/toolkit/blob/1cc56db0ff126f4d65aeb83798852e02a2c180c3/packages/github/src/context.ts#L10-L20

Expected behavior

Per the docs I expect to be able to access the workspace property on a github context.

Contributor guide

Open the contributing guide

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 with packages/github/src/context.ts at the linked lines and inspect how the existing github context properties are exposed. Add the missing workspace property consistently with the surrounding context fields, then check the package's existing tests or validation commands. Done means consumers can access github.workspace as described in the GitHub Actions context documentation.

Written by the indexing model from the issue text.

Assessment

Tech stack
github, typescript
Domain
tooling
Issue type
Bug
Difficulty
1/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
55/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.