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

Development: Remove outdated references to the clone button #9063

Merged
merged 6 commits into from
Jul 17, 2024

Conversation

pzdr7
Copy link
Contributor

@pzdr7 pzdr7 commented Jul 15, 2024

Checklist

General

Client

  • Important: I implemented the changes with a very good performance, prevented too many (unnecessary) REST calls and made sure the UI is responsive, even with large data.
  • I added multiple screenshots/screencasts of my UI changes.

Changes affecting Programming Exercises

  • High priority: I tested all changes and their related features with all corresponding user types on a test server configured with the integrated lifecycle setup (LocalVC and LocalCI).

Motivation and Context

We had some outdated translations that still refer to the "Clone repository" button, which was removed in #8920. This is an inconsistency that we want to avoid.

Description

Updated the translations. Also went through the code and got rid of remaining references to the "Clone repository" button.

Steps for Testing

Prerequisites:

  • 1 Programming exercise with only local IDE enabled (disable the online editor)
  • 1 Student who has not started their participation on the exercise yet
  1. Log in to Artemis
  2. Navigate to the programming exercise
  3. Start the participation and pay attention to the alert on the top right. Make sure it refers to the "Code" button ⚠️

For the code review

Warning

Check out the branch and search for occurrences (Ctrl+Shift+F / Cmd+Shift+F on Mac) that may still refer to the removed "Clone repository" button. (e.g. using terms like "clone", "clone repo" "clone repository" "clone button" etc.) Occurrences
that don't refer to the button but rather to the action of cloning the repo are fine.

Testserver States

Note

These badges show the state of the test servers.
Green = Currently available, Red = Currently locked
Click on the badges to get to the test servers.







Review Progress

Code Review

  • Code Review 1
  • Code Review 2

Manual Tests

  • Test 1
  • Test 2

Test Coverage

Unchanged

Screenshots

image

Summary by CodeRabbit

  • New Features

    • Updated user interface text and component behavior to replace "Clone" button references with more accurate "Code" button terminology for a clearer user experience.
  • Bug Fixes

    • Fixed inconsistencies in button naming conventions across various components and test files to ensure uniform user instructions.
  • Documentation

    • Updated language in instructional text for personal repository setup to enhance clarity and consistency.

@github-actions github-actions bot added tests client Pull requests that update TypeScript code. (Added Automatically!) labels Jul 15, 2024
@pzdr7 pzdr7 temporarily deployed to artemis-test1.artemis.cit.tum.de July 15, 2024 19:47 — with GitHub Actions Inactive
@pzdr7 pzdr7 marked this pull request as ready for review July 15, 2024 20:29
@pzdr7 pzdr7 requested a review from a team as a code owner July 15, 2024 20:29
Copy link

coderabbitai bot commented Jul 15, 2024

Walkthrough

The changes primarily involve renaming various elements related to code button functionality across multiple files in the web application. This includes updating component templates, variables, comments, and text prompts for improved clarity and consistency in user interactions. The changes affect both the frontend user interface and the corresponding test cases, ensuring that the application reflects the updated terminology.

Changes

File Path Change Summary
.../programming-exam-submission.component.html Updated comment from "ngIf Offline IDE clone button start" to "ngIf Offline IDE code button start".
.../orion-exercise-details-student-actions.component.html Renamed template reference variable overrideCloneOnlineEditorButton to overrideCodeAndOnlineEditorButton.
.../exercise-details-student-actions.component.html Updated jhiExtensionPoint context from overrideCloneOnlineEditorButton to overrideCodeAndOnlineEditorButton.
.../exercise-details-student-actions.component.ts Renamed @ContentChild variable from overrideCloneOnlineEditorButton to overrideCodeAndOnlineEditorButton. Updated related comment.
.../i18n/de/exercise.json Updated prompt text for "personalRepositoryClone" to instruct clicking the "Code" button instead of "Repository klonen".
.../i18n/en/exercise.json Updated prompt text for "personalRepositoryClone" to instruct clicking the "Code" button instead of "Clone repository".
.../programming-exam-summary.component.spec.ts Renamed variable modelingSubmissionComponent to feedbackComponent.
.../code-button.component.spec.ts Updated branch name from 'clone-repo-button' to 'code-button'.
.../navbar.component.spec.ts Updated git branch name from 'clone-repo-button' to 'code-button' in profileInfo and expectations.
.../profile.service.spec.ts Updated git object's branch property from 'clone-repo-button' to 'code-button'.

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>.
    • 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[bot]
coderabbitai bot previously requested changes Jul 15, 2024
Copy link

@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

Copy link
Contributor

@b-fein b-fein left a comment

Choose a reason for hiding this comment

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

Code changes look good.

@krusche krusche added this to the 7.4.3 milestone Jul 17, 2024
@krusche krusche merged commit 6259c62 into develop Jul 17, 2024
20 of 24 checks passed
@krusche krusche deleted the chore/development/remove-references-to-clone-button branch July 17, 2024 06:25
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
client Pull requests that update TypeScript code. (Added Automatically!) ready for review tests
Projects
Archived in project
Development

Successfully merging this pull request may close these issues.

3 participants