ci: add additional tags for identification on nightly performance test runs

[morde08]

Description

add additional tags jobName and testId for identification on nightly performance test runs for when reports are uploaded to Pushgateway/Grafana.

How Has This Been Tested?

• Tested CCTX in localnet
• Tested in development environment
• Go unit tests
• Go integration tests
• Tested via GitHub Actions

Summary by CodeRabbit

• New Features
  • Added new tags to the performance tests configuration to enhance metadata for test identification.
  • Introduced a new environment variable in the nightly performance testing workflow for better logging and context in generated artifacts.

These improvements aim to enhance the organization and traceability of performance testing within the workflow.

[coderabbitai]

Important

Review skipped

Auto incremental reviews are disabled on this repository.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Walkthrough

Walkthrough

The recent changes enhance the GitHub Actions workflow for performance testing by introducing new metadata tags in the configuration file and adding a dynamic environment variable to capture the action's name. These updates improve the traceability and context of performance test executions without altering existing logic, thereby enriching the overall functionality of the testing process.

Changes

Files	Change Summary
.github/actions/performance-tests/art.yaml	Added tags to the config section: testId:-=GITHUB_ACTION=-, jobName:evm-performance-test for enhanced metadata.
.github/workflows/ci-nightly-performance-testing.yaml	Introduced a new environment variable GITHUB_ACTION to capture the action's name, allowing for dynamic updates in art.yaml.

Sequence Diagram(s)

sequenceDiagram
    participant A as GitHub Action
    participant B as ci-nightly-performance-testing.yaml
    participant C as art.yaml

    A->>B: Start performance testing
    B->>B: Set GITHUB_ACTION = current action name
    B->>C: Replace placeholder with GITHUB_ACTION value
    C->>C: Update configuration with new metadata
    B->>A: Complete testing with updated config

Loading

---

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share

• X
• Mastodon
• Reddit
• LinkedIn

Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>.
  • Generate unit testing code for this file.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai generate unit testing code for this file.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai generate interesting stats about this repository and render them as a table.
  • @coderabbitai show all the console.log statements in this repository.
  • @coderabbitai read src/utils.ts and generate unit testing code.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (invoked as PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[coderabbitai]

Actionable comments posted: 0

Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL

Commits

Files that changed from the base of the PR and between e6ce681 and bc9ac24.

Files selected for processing (2)

• .github/actions/performance-tests/art.yaml (1 hunks)
• .github/workflows/ci-nightly-performance-testing.yaml (1 hunks)

Additional comments not posted (3)

.github/workflows/ci-nightly-performance-testing.yaml (2)

41-41: Addition of GITHUB_ACTION environment variable approved.

The inclusion of the GITHUB_ACTION environment variable enhances the dynamic configuration of the performance testing by allowing the action name to be included in the generated YAML file. This can be useful for logging or debugging purposes.

---

47-48: Use of GITHUB_ACTION in sed command approved.

The sed command correctly replaces the -=GITHUB_ACTION=- placeholder in the art.yaml file with the value of the GITHUB_ACTION environment variable.

.github/actions/performance-tests/art.yaml (1)

22-23: Addition of testId and jobName tags approved.

The inclusion of the testId:-=GITHUB_ACTION=- and jobName:evm-performance-test tags enhances the configuration by providing additional metadata for the performance tests, facilitating better categorization and identification of specific test executions.

[lumtis]

utACK