Skip to content

Manifest references + Node semver migration#2416

Merged
simon-id merged 16 commits intomainfrom
manifest_refs
May 29, 2024
Merged

Manifest references + Node semver migration#2416
simon-id merged 16 commits intomainfrom
manifest_refs

Conversation

@simon-id
Copy link
Copy Markdown
Member

@simon-id simon-id commented May 1, 2024

Motivation

Introduces a special optional field refs in manifests, it should hold a list of reference definitions, to be used elsewhere in the manifests.
Example:

refs:
  - &version_A '>=5.6.0 || 4.7.0'
  - &version_B v2.3.0

tests/:
  file.py:
    ClassA: *version_A
    ClassB: *version_B

It synergizes particularly well with SemVer support, to reduce noies and potential errors.

Changes

  • Add documentation on the feature and recommendations on using it.
  • Change all the Node.js versions with their full SemVer descriptors and use a ref table for it.
  • Add a special case in manifest parsing to not consider the refs field as a test file.
  • Update the JSON Schema for the manifests.

Workflow

  1. ⚠️ Create your PR as draft ⚠️
  2. Work on you PR until the CI passes (if something not related to your task is failing, you can ignore it)
  3. Mark it as ready for review
    • Test logic is modified? -> Get a review from RFC owner. We're working on refining the codeowners file quickly.
    • Framework is modified, or non obvious usage of it -> get a review from R&P team

🚀 Once your PR is reviewed, you can merge it!

🛟 #apm-shared-testing 🛟

Reviewer checklist

  • Relevant label (run-parametric-scenario, run-profiling-scenario...) are presents
  • If PR title starts with [<language>], double-check that only <language> is impacted by the change
  • No system-tests internal is modified. Otherwise, I have the approval from R&P team
  • CI is green, or failing jobs are not related to this change (and you are 100% sure about this statement)
  • A docker base image is modified?
    • the relevant build-XXX-image label is present
  • A scenario is added (or removed)?

@simon-id simon-id self-assigned this May 1, 2024
@simon-id simon-id changed the title Manifest refs Manifest references + Node semver migration May 1, 2024
Comment thread manifests/nodejs.yml Outdated
@simon-id simon-id added the dev-x Improve developer experience label May 1, 2024
@simon-id
Copy link
Copy Markdown
Member Author

simon-id commented May 2, 2024

Job is failing because the system-tests transforms the valid semver version provided by the Node library 6.0.0-pre into 6.0.0pre which is not a valid string

@simon-id
Copy link
Copy Markdown
Member Author

ok it's fixed now 👍

@simon-id simon-id marked this pull request as ready for review May 27, 2024 17:59
@simon-id simon-id requested review from a team as code owners May 27, 2024 17:59
Copy link
Copy Markdown
Contributor

@CarlesDD CarlesDD left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

Copy link
Copy Markdown
Contributor

@khanayan123 khanayan123 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@simon-id simon-id merged commit 4e2af43 into main May 29, 2024
@simon-id simon-id deleted the manifest_refs branch May 29, 2024 06:20
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

dev-x Improve developer experience

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants