Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix: workaround for github number error in dispatch workflow #1367

Merged
merged 7 commits into from
Nov 1, 2024

Conversation

dagfinno
Copy link
Contributor

@dagfinno dagfinno commented Oct 31, 2024

Workaround for issue mentioned here: https://github.com/orgs/community/discussions/67182
Made testSuitePath a type choice and added tests to the list

Related Issue(s)

Verification

  • Your code builds clean without any errors or warnings
  • Manual testing done (required)
  • Relevant automated test added (if you find this hard, leave it and we'll help out)

Documentation

  • Documentation is updated (either in docs-directory, Altinnpedia or a separate linked PR in altinn-studio-docs., if applicable)

Summary by CodeRabbit

  • New Features
    • Enhanced input handling for performance tests, allowing users to select from predefined test suite paths.
    • Improved processing of virtual users (VUs) input for better validation and structure.

@dagfinno dagfinno requested review from a team as code owners October 31, 2024 11:50
Copy link
Contributor

coderabbitai bot commented Oct 31, 2024

📝 Walkthrough
📝 Walkthrough

Walkthrough

The pull request modifies the K6 performance test workflow configuration in the .github/workflows/dispatch-k6-performance.yml file. It enhances the handling and validation of input parameters, specifically the vus and testSuitePath. The vus input is now processed using fromJson, and the testSuitePath input has been changed to a choice type with predefined options for specific test suite paths.

Changes

File Path Change Summary
.github/workflows/dispatch-k6-performance.yml - Updated vus input to process as vus: ${{ fromJson(inputs.vus) }}.
- Changed testSuitePath input to type: choice with predefined options for test suite paths.

Possibly related PRs

Suggested reviewers

  • oskogstad

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
🪧 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>, please review it.
    • 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 gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @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 using 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.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

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.

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 1

🧹 Outside diff range and nitpick comments (1)
.github/workflows/dispatch-k6-performance.yml (1)

43-46: Consider making test paths more maintainable

The change to type: choice with predefined options improves usability and prevents errors. However, consider moving these test paths to a reusable workflow variable or configuration file to make future updates easier.

Example approach using a reusable variable:

# In a shared config file or at the top of the workflow
test_suite_paths:
  serviceowner_create_dialog: 'tests/k6/tests/serviceowner/performance/create-dialog.js'
  enduser_simple_search: 'tests/k6/tests/enduser/performance/simple-search.js'

# Then in the inputs section
options:
  - ${{ vars.test_suite_paths.serviceowner_create_dialog }}
  - ${{ vars.test_suite_paths.enduser_simple_search }}
📜 Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 49c1d80 and e45de27.

📒 Files selected for processing (1)
  • .github/workflows/dispatch-k6-performance.yml (3 hunks)
🔇 Additional comments (1)
.github/workflows/dispatch-k6-performance.yml (1)

33-33: LGTM: Explicit type declaration for VUS input

The explicit type: number declaration ensures proper type validation for the virtual users input parameter.

.github/workflows/dispatch-k6-performance.yml Show resolved Hide resolved
Copy link

sonarcloud bot commented Oct 31, 2024

@dagfinno dagfinno merged commit 06ee356 into main Nov 1, 2024
23 checks passed
@dagfinno dagfinno deleted the performance/workflow-fixes branch November 1, 2024 08:37
@coderabbitai coderabbitai bot mentioned this pull request Nov 1, 2024
4 tasks
arealmaas added a commit that referenced this pull request Nov 5, 2024
🤖 I have created a release *beep* *boop*
---


##
[1.28.0](v1.27.1...v1.28.0)
(2024-11-05)


### Features

* update swagger name generation
([#1350](#1350))
([94c5544](94c5544))
* **webapi:** Add ExternalReference to dialog search result
([#1384](#1384))
([431fe16](431fe16))
* **webapi:** Return 410 GONE for notification checks on deleted dialogs
([#1387](#1387))
([198bebd](198bebd))


### Bug Fixes

* Add system user id to identifying claims
([#1362](#1362))
([16f160d](16f160d))
* **e2e:** Use pagination in sentinel
([#1372](#1372))
([a1df0ff](a1df0ff))
* fixed placement of referenced workflow-file
([#1365](#1365))
([49c1d80](49c1d80))
* workaround for github number error in dispatch workflow
([#1367](#1367))
([06ee356](06ee356))

---
This PR was generated with [Release
Please](https://github.com/googleapis/release-please). See
[documentation](https://github.com/googleapis/release-please#release-please).
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants