Merge pull request #76 from ctrf-io/feat/expose-context

Feat/expose context

Author: Ma11hewThomas

badges/coverage.svg

@@ -47,7 +47,7 @@ properties `ctrf` property, for example `ctrf.summary.passed`
 GitHub properties are made available to use in your template. You can access
 these properties `github` property, for example `github.repoName`
 
-You can access the context via the `github.context` property.
+You can access the entire context via the `github.context` property.
 
 [Contexts](https://docs.github.com/en/actions/writing-workflows/choosing-what-your-workflow-does/accessing-contextual-information-about-workflow-runs)
 are a way to access information about workflow runs, variables, runner
@@ -58,7 +58,16 @@ Contexts, objects, and properties will vary significantly under different
 workflow run conditions. For example, the matrix context is only populated for
 jobs in a matrix.
 
-In addition common properties are made available.
+You can see the content of the context by printing it in the logs:
+
+```yaml
+- name: Print GitHub Context
+  env:
+    CONTEXT: ${{ toJson(github) }}
+  run: echo "$CONTEXT" | jq .
+```
+
+In addition to context, common properties are made available.
 
 ### Root Context
 

dist/index.js

@@ -20,13 +20,15 @@ export function getAllGitHubContext(): GitHubContext {
   const repository = getRepositoryContext()
   const pullRequest = getPullRequestContext()
   const sender = getSenderContext()
+  const ghContext = context.payload
 
   return {
     ...root,
     ...additional,
     repository,
     pullRequest,
-    sender
+    sender,
+    context: ghContext
   }
 }
 

dist/index.js.map

@@ -18,6 +18,7 @@ export interface GitHubContext
   repository: GitHubRepositoryContext
   pullRequest: GitHubPullRequestContext
   sender: GitHubSenderContext
+  context: unknown
 }
 
 export interface GitHubRootContext {