Add update-specs updatcli workflow #1745
Conversation
github-actions
bot
added
agent-python
community
| error.json: | ||
| kind: file | ||
| spec: | ||
| file: https://raw.githubusercontent.com/elastic/apm-data/main/input/elasticapm/docs/spec/v2/error.json | ||
| metadata.json: | ||
| kind: file | ||
| spec: | ||
| file: https://raw.githubusercontent.com/elastic/apm-data/main/input/elasticapm/docs/spec/v2/metadata.json | ||
| metricset.json: | ||
| kind: file | ||
| spec: | ||
| file: https://raw.githubusercontent.com/elastic/apm-data/main/input/elasticapm/docs/spec/v2/metricset.json | ||
| span.json: | ||
| kind: file | ||
| spec: | ||
| file: https://raw.githubusercontent.com/elastic/apm-data/main/input/elasticapm/docs/spec/v2/span.json | ||
| transaction.json: | ||
| kind: file | ||
| spec: | ||
| file: https://raw.githubusercontent.com/elastic/apm-data/main/input/elasticapm/docs/spec/v2/transaction.json |
There was a problem hiding this comment.
@axw
Is it okay for this to be a "static list" of files, or do we need something more dynamic here that considers file additions/deletions?
There was a problem hiding this comment.
What are our other options? The set of files won't change often, but they might still change. I think we could go ahead with this, and look at bundling the schema documents into a Compound Schema Document: http://json-schema.org/understanding-json-schema/structuring.html#bundling
There was a problem hiding this comment.
Opened elastic/apm-data#15 to improve this
There was a problem hiding this comment.
Another option could be a shell script that does the cloning and copying of the files. Which feels a bit hacky in the updatecli way, but is certainly possible.
Regardless, a compound schema sounds really good! This will also account for deletions.
I actually encountered a case where log.json was not removed (Also in the current implementation). (See elastic/apm-agent-nodejs#3153 (review)) A single file would fix this behaviour.
P.S.
From what I've seen, something like rsync --delete, to account for deletions, probably won't work seemlessly either.. because in some repos the schemas are in the same folder with other schemas.
* Add update-specs updatcli workflow * Fix paths
* handle case when no span is created in GRPC client interceptor closes #1739 * Migrate Jenkinsfile 2 GH Actions Workflow (#1731) * Migrate Jenkinsfile to GH Actions * Generic naming * Upload junit test and coverage reports on success or on failure * Better naming * Remove cron from packages workflow * Rename all occurences of WEBFRAMEWORK to FRAMEWORK * Add a warning about BaseHTTPMiddleware to Starlette docs (#1735) * Add a warning about BaseHTTPMiddleware to Starlette docs Also switch to using get_client() and make the docs simpler for environment variable configuration. * CHANGELOG * Change `server_url` default to avoid ipv6 ambiguity (#1744) * Change `server_url` default to avoid ipv6 ambiguity * Fix failing test and another minor doc fix * Add service.agent.activation_method to metadata (#1743) * Add activation_method to metadata * Add test * Move activation_method default above start_threads * CHANGELOG * Fix nightly scheduled test (#1747) * Split matrix items into chunks to bypass the 256 limit of matrix items in github actions * cleanup * Add comments * Add update-specs updatcli workflow (#1745) * Add update-specs updatcli workflow * Fix paths * Required Status Check (#1749) * Create single status check that can be set as required * Let windows test runs exit with the correct exit code * Set the exit code * Formatting * fix * More readable jq query * Set status check to success in case it's an only-docs PR (#1753) * Set status check to success in case it's a only-docs PR * Set permissions * fix path patterns * Add comments * Update badge (#1752) * Add dynamic config tag to more supported options (#1750) * Fix sha source (#1754) * update changelog --------- Co-authored-by: Jan Calanog <[email protected]> Co-authored-by: Colton Myers <[email protected]> Co-authored-by: Jan Calanog <[email protected]>
What does this pull request do?
Moves the update specs workflow from apm-server to the consumer using updatecli to have a "dependabot"-like experience.
How to test
Related issues