scalableminds / webknossos

Visualize, share and annotate your large 3D images online
https://webknossos.org
GNU Affero General Public License v3.0
127 stars 24 forks source link

Always Upload Screenshot Artifacts for Nightly Tests #8171

Closed hotzenklotz closed 1 week ago

hotzenklotz commented 1 week ago

Changes:

Steps to test:


(Please delete unneeded items, merge only when none are left open)

Summary by CodeRabbit

coderabbitai[bot] commented 1 week ago

Walkthrough

The changes in this pull request involve updates to two GitHub workflow files and a TypeScript file related to Puppeteer testing. In the workflow files, a conditional statement if: always() was added to the "Upload screenshots as artifact" step, ensuring that screenshots are uploaded regardless of the success or failure of preceding steps. In the TypeScript file, a new function for retrieving the BrowserStack session ID was introduced, and modifications were made to enhance session management and logging during Puppeteer tests.

Changes

File Path Change Summary
.github/workflows/nightly.yml Updated action version to actions/upload-artifact@v4 and added if: always() to "Upload screenshots as artifact" step to ensure execution regardless of previous step outcomes.
.github/workflows/wkorg-nightly.yaml Updated action version to actions/upload-artifact@v4 and added if: always() to "Upload screenshots as artifact" step within nightly-screenshot-tests job to ensure screenshots are uploaded even if tests fail.
frontend/javascripts/test/puppeteer/dataset_rendering_helpers.ts Introduced getBrowserstackSessionId function for retrieving session ID from BrowserStack. Updated setupBeforeEachAndAfterEach to include name in caps and modified browser instance handling. Minor logging enhancements added.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant GitHub Actions
    participant Puppeteer
    participant BrowserStack

    User->>GitHub Actions: Trigger nightly workflow
    GitHub Actions->>Puppeteer: Start tests
    alt Tests succeed
        Puppeteer->>GitHub Actions: Upload screenshots
    else Tests fail
        Puppeteer->>GitHub Actions: Upload screenshots
    end
    GitHub Actions->>User: Notify completion

🐰 "In the workflows, a change so bright,
Screenshots now upload, day or night.
With BrowserStack, we fetch the ID,
Our tests run smoothly, oh yes indeed!
So hop along, let's celebrate,
With joyful bounces, it's truly great!" 🥕


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](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai) - [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai) - [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai) - [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)
🪧 Tips ### Chat There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai): - Review comments: Directly reply to a review comment made by CodeRabbit. Example: - `I pushed a fix in commit , 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. ### 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](https://docs.coderabbit.ai/guides/configure-coderabbit) 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](https://coderabbit.ai/docs) for detailed information on how to use CodeRabbit. - Join our [Discord Community](http://discord.gg/coderabbit) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.
hotzenklotz commented 1 week ago

Seems to work. See this action run which includes BrowserStack Ids and the BrowserStack UI showing names for each invocation: https://github.com/scalableminds/webknossos/actions/runs/11701122812/job/32586545549

Screenshot 2024-11-06 at 11 05 57