@effected/github-actions 0.33.0 → 0.33.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/index.d.ts +23 -0
  2. package/package.json +4 -4
package/index.d.ts CHANGED
@@ -1,3 +1,26 @@
1
+ /**
2
+ * The GitHub Actions runtime for Effect: the services an action needs to talk
3
+ * to the runner it executes inside.
4
+ *
5
+ * {@link Action.run} composes the default runtime ({@link ActionRuntime}), runs
6
+ * your program, renders a failure as an `::error::` annotation and sets the exit
7
+ * code. {@link ActionInput} reads workflow inputs as typed `Config` values, and
8
+ * {@link ActionOutputs}, {@link ActionState}, {@link ActionLogger} and
9
+ * {@link ActionEnvironment} cover outputs, cross-phase state, workflow-command
10
+ * logging and the runner's variables. Heavier protocols are opt-in services:
11
+ * {@link ActionCache}, {@link Artifact}, {@link BlobStore}, {@link ToolInstaller},
12
+ * {@link PackageManagerInstaller}, {@link OidcTokenIssuer} and the GitHub App
13
+ * token bridge {@link GitHubToken}. {@link Secret} is the one place a `Redacted`
14
+ * value becomes plaintext, and always masks first. A reporting suite
15
+ * ({@link GitHubMarkdown}, {@link ManagedDocument}, {@link CheckState} and
16
+ * {@link CheckDocument}) renders what a run did onto a pull request comment, a
17
+ * check run or the job summary.
18
+ *
19
+ * The cache, artifact and tool-cache protocols are implemented directly against
20
+ * their HTTP APIs, with no `@actions/*` dependency.
21
+ *
22
+ * @packageDocumentation
23
+ */
1
24
  import { AnnotationProperties, AnnotationProperties as AnnotationProperties$1, WorkflowCommand } from "@effected/github-commands";
2
25
  import * as NodeServices from "@effect/platform-node/NodeServices";
3
26
  import { Cause, Config, ConfigProvider, Context, Duration, Effect, FileSystem, Layer, Logger, Option, Path, Redacted, Result, Schema, SchemaAST } from "effect";
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@effected/github-actions",
3
- "version": "0.33.0",
3
+ "version": "0.33.1",
4
4
  "private": false,
5
5
  "description": "The GitHub Actions runtime: env, inputs, outputs, state, logging, cache, artifacts, blob storage, OIDC and the token bridge.",
6
6
  "keywords": [
@@ -40,17 +40,17 @@
40
40
  "dependencies": {
41
41
  "@azure/storage-blob": "^12.33.0",
42
42
  "@effected/crypto": "^0.7.0",
43
- "@effected/github": "^0.32.0",
43
+ "@effected/github": "^0.32.1",
44
44
  "@effected/github-commands": "^0.10.0",
45
45
  "@effected/glob": "^0.21.0",
46
46
  "@effected/jwt": "^0.10.0",
47
47
  "@effected/markdown": "^0.29.0",
48
- "@effected/npm": "^0.33.0",
48
+ "@effected/npm": "^0.34.0",
49
49
  "@effected/oidc": "^0.5.0",
50
50
  "@effected/sbom": "^0.21.0",
51
51
  "@effected/semver": "^0.24.0",
52
52
  "@effected/templates": "^0.20.0",
53
- "@effected/walker": "^0.27.0",
53
+ "@effected/walker": "^0.28.0",
54
54
  "@effected/yaml": "^0.30.0"
55
55
  },
56
56
  "peerDependencies": {