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

[BUGFIX] [ENHANCEMENT] create users and workspaces with predefined ID #5786

Merged

Conversation

frascuchon
Copy link
Member

Description

This PR allows users and workspaces to be created with predefined IDs. Passing a predefined ID when creating workspaces and users simplifies the migration process since users don't need to review responses and map them to new users, avoiding potential issues in the process.

Type of change

  • Bug fix (non-breaking change which fixes an issue)
  • Improvement (change adding some improvement to an existing functionality)
  • Documentation update

How Has This Been Tested

Checklist

  • I added relevant documentation
  • I followed the style guidelines of this project
  • I did a self-review of my code
  • I made corresponding changes to the documentation
  • I confirm My changes generate no new warnings
  • I have added tests that prove my fix is effective or that my feature works
  • I have added relevant notes to the CHANGELOG.md file (See https://keepachangelog.com/)

Copy link

codecov bot commented Jan 20, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 91.95%. Comparing base (dc3deab) to head (b363088).
Report is 1 commits behind head on develop.

Additional details and impacted files
@@             Coverage Diff             @@
##           develop    #5786      +/-   ##
===========================================
+ Coverage    91.94%   91.95%   +0.01%     
===========================================
  Files          161      161              
  Lines         6918     6927       +9     
===========================================
+ Hits          6361     6370       +9     
  Misses         557      557              
Flag Coverage Δ
argilla-server 91.95% <100.00%> (+0.01%) ⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

Copy link
Member

@davidberenstein1957 davidberenstein1957 left a comment

Choose a reason for hiding this comment

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

@frascuchon, looks good.

I would also update the API ref docs but I think we can leave the how to guides as is for simplicity.

  • argilla/docs/reference/argilla/users.md
  • argilla/docs/reference/argilla/workspaces.md

@davidberenstein1957 davidberenstein1957 added this to the v2.6.1 milestone Jan 20, 2025
@frascuchon frascuchon modified the milestones: v2.6.1, v2.7.0 Jan 20, 2025
Copy link
Member

@davidberenstein1957 davidberenstein1957 left a comment

Choose a reason for hiding this comment

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

I would also update the API ref docs but I think we can leave the how to guides as is for simplicity.

argilla/docs/reference/argilla/users.md
argilla/docs/reference/argilla/workspaces.md

@frascuchon
Copy link
Member Author

@frascuchon, looks good.

I would also update the API ref docs but I think we can leave the how to guides as is for simplicity.

  • argilla/docs/reference/argilla/users.md
  • argilla/docs/reference/argilla/workspaces.md

The ref docs are quite base, they omit other relevant attributes such as role. I prefer not to touch them. I've included more info in the init args description to reflect this new feature.

@frascuchon frascuchon merged commit 6a00494 into develop Jan 20, 2025
1 of 7 checks passed
@frascuchon frascuchon deleted the feat/create-users-and-workspaces-with-predefined-id branch January 20, 2025 14:18
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