You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
* chore: More CDD updates
Co-Authored-By: Claude <noreply@anthropic.com>
* chore: Fix mistakes
* chore: Update automated test to include all inputs
* chore: Fix Claude issues
* chore: Moving files
* chore: Fixing path
* chore: Updating so test files can be found
* chore: Removing docs test for now
* chore: Remove extra input params - get from files instead
* fix: Allow .fleetControl to be missing in docs case
* fix: Fixes for the 2 use cases
---------
Co-authored-by: Claude <noreply@anthropic.com>
Copy file name to clipboardExpand all lines: README.md
+15-7Lines changed: 15 additions & 7 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -18,7 +18,9 @@ Add this action to your workflow after checking out your repository:
18
18
19
19
## Usage
20
20
21
-
This action reads the `.fleetControl/configurationDefinitions.yml` file from your repository and outputs the configuration definitions. The action expects the file to be present after the repository has been checked out.
21
+
This action reads the `.fleetControl/configurationDefinitions.yml` file from your repository and saves the agent information in New Relic.
22
+
The action expects the file to be present after the repository has been checked out. If you do not want to use this action,
23
+
you can call New Relic directly to add the agent information.
22
24
23
25
### Example Workflow For Releasing a New Agent Version
24
26
@@ -40,7 +42,8 @@ jobs:
40
42
- name: Read agent metadata
41
43
uses: newrelic/agent-metadata-action@v1
42
44
with:
43
-
version: 1.0.0 # only required if different from ref tag
45
+
agent-type: dotnet # Required: The type of agent (e.g., dotnet, java, python)
46
+
version: 1.0.0 # Required
44
47
cache: true # Optional: Enable Go build cache (default: true)
45
48
```
46
49
@@ -62,7 +65,14 @@ jobs:
62
65
- name: Read agent metadata
63
66
uses: newrelic/agent-metadata-action@v1
64
67
with:
65
-
version: 1.0.0 # required in the docs case
68
+
agent-type: java # Required: The type of agent (e.g., dotnet, java, python)
69
+
version: 1.0.0 # required
70
+
features: feature1,feature2 # Optional: Comma-separated list of features
71
+
bugs: bug-123,bug-456 # Optional: Comma-separated list of bug fixes
72
+
security: CVE-2024-1234 # Optional: Comma-separated list of security fixes
73
+
deprecations: deprecated-feature1 # Optional: Comma-separated list of deprecations
74
+
supportedOperatingSystems: linux,windows,darwin # Optional: Comma-separated list of supported OSes
75
+
eol: 2025-12-31 # Optional: End of life date
66
76
cache: true # Optional: Enable Go build cache (default: true)
67
77
```
68
78
@@ -72,17 +82,15 @@ The action expects a YAML file at `.fleetControl/configurationDefinitions.yml` w
72
82
73
83
```yaml
74
84
configurationDefinitions:
75
-
- name: "Configuration Name"
76
-
slug: "config-slug"
77
-
platform: "kubernetes" # or "host"
85
+
- platform: "kubernetes" # or "host"
78
86
description: "Description of the configuration"
79
87
type: "config-type"
80
88
version: "1.0.0"
81
89
format: "json"
82
90
schema: "./schemas/config-schema.json"
83
91
```
84
92
85
-
**All fields are required.** The action validates each configuration entry and will fail with a clear error message if any required field is missing.
93
+
**All fields are required.** The action validates each configuration entry and will fail with a clear error message if any required field is missing (version, platform, description, type, format, schema).
86
94
87
95
**Schema files** are automatically base64-encoded and embedded in the output. Schema paths must be relative to the `.fleetControl` directory and cannot use directory traversal (`..`) for security.
// @todo use the AgentMetadata object to call the InstrumentationMetadata service to add/update the agent in NGEP
57
72
printJSON("Agent Metadata", agentMetadata)
58
73
} else {
59
-
// Docs workflow: only output metadata
60
-
fmt.Println("::notice::Running in metadata-only mode (no workspace provided)")
74
+
// Scenario 2: Docs workflow
75
+
fmt.Println("::notice::Running in metadata-only mode (.fleetControl not found, using MDX files)")
61
76
// @todo use the INPUT_AGENT_TYPE along with the metadata to call the InstrumentationMetadata service for updating the agent in NGEP with extra metadata
0 commit comments