Add Api, ReadOnlyEnv, and Base state features#4009
Open
mbg wants to merge 6 commits into
Open
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
Adds opt-in Base, Api, and ReadOnlyEnv features to ActionState.
Changes:
- Makes base state explicitly requested.
- Adds API-client and read-only environment state features.
- Updates action and test-state typings.
Show a summary per file
| File | Description |
|---|---|
src/action-common.ts |
Defines new state features and optional base state. |
src/api-client.ts |
Exports the API client type. |
src/testing-utils.ts |
Initializes all new features in test state. |
src/analyze-action.ts |
Requests base state. |
src/autobuild-action.ts |
Requests base state. |
src/init-action.ts |
Requests base state. |
src/setup-codeql-action.ts |
Requests base state. |
src/upload-sarif-action.ts |
Requests base state. |
Review details
- Files reviewed: 8/8 changed files
- Comments generated: 2
- Review effort level: Medium
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
A small PR adding new
ApiandReadOnlyEnvfeatures to the state features available throughActionState. This also changes theBaseStateto only be available if explicitly requested with the newBasefeature. This allows us to retrofitActionStatemore easily to existing code, since we don't need to get hold of thestartedAttime and the action name, if those aren't needed.Risk assessment
For internal use only. Please select the risk level of this change:
Which use cases does this change impact?
Workflow types:
dynamicworkflows (Default Setup, Code Quality, ...).Products:
analysis-kinds: code-scanning.analysis-kinds: code-quality.upload-sarifaction.Environments:
github.comand/or GitHub Enterprise Cloud with Data Residency.How did/will you validate this change?
.test.tsfiles).pr-checks).If something goes wrong after this change is released, what are the mitigation and rollback strategies?
How will you know if something goes wrong after this change is released?
Are there any special considerations for merging or releasing this change?
Merge / deployment checklist