Skip to content

feat(@actions/github): added refName and refType to context #2440

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
fearphage wants to merge 2 commits into
base: main
Choose a base branch
from
+32 −0
Open

feat(@actions/github): added refName and refType to context #2440

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
e0aadd5
feat: added `refName` and `refType` to context
fearphage Jun 19, 2026
a3590c0
added missing unit tests
fearphage Jun 19, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 28 additions & 0 deletions packages/github/__tests__/lib.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -79,4 +79,32 @@ describe('@actions/context', () => {
repo: 'test'
})
})

describe('refs', () => {
it.each([
'refs/heads/main',
'refs/heads/feature-branch',
'refs/pull/42/merge',
'refs/tags/v2.0.4'
])(`should set context.ref: %s`, ref => {
process.env.GITHUB_REF = ref

expect(new Context()).toHaveProperty(`ref`, ref)
})

it.each([`meh-${Date.now()}`, 'catpants', 'v1.2.3'])(
'should set context.refName: %s',
refName => {
process.env.GITHUB_REF_NAME = refName

expect(new Context()).toHaveProperty('refName', refName)
}
)

it.each(['branch', 'tag'])('should set context.refType: %s', refType => {
process.env.GITHUB_REF_TYPE = refType

expect(new Context()).toHaveProperty('refType', refType)
})
})
})
4 changes: 4 additions & 0 deletions packages/github/src/context.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,8 @@ export class Context {
eventName: string
sha: string
ref: string
refName: string
refType: string
workflow: string
action: string
actor: string
Expand Down Expand Up @@ -41,6 +43,8 @@ export class Context {
this.eventName = process.env.GITHUB_EVENT_NAME as string
this.sha = process.env.GITHUB_SHA as string
this.ref = process.env.GITHUB_REF as string
this.refName = process.env.GITHUB_REF_NAME as string
this.refType = process.env.GITHUB_REF_TYPE as string
Comment on lines 43 to +47
this.workflow = process.env.GITHUB_WORKFLOW as string
this.action = process.env.GITHUB_ACTION as string
this.actor = process.env.GITHUB_ACTOR as string
Expand Down