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.

Sign up for GitHub

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

Jump to bottom

Rename components directory to resources under .dapr directory #1148

Open
pravinpushkar opened this issue Dec 8, 2022 · 10 comments · May be fixed by #1149
Open

Rename components directory to resources under .dapr directory #1148

pravinpushkar opened this issue Dec 8, 2022 · 10 comments · May be fixed by #1149
Assignees
@pravinpushkar
Labels
area/cli kind/enhancement enhancement to an existing feature kind/proposal A new proposal to be considered P1 size/S 1 week of work triaged/resolved The issue has been triaged
Milestone
v1.15

Comments

@pravinpushkar
Copy link
Contributor

Describe the proposal

The issue #953 layout a proposal for using resources-path flag with dapr run instead of components-path flag and slowly deprecating it.
In the similar context it would make sense to rename components directory to resources and slowly deprecate components directory use.

Since the components directory is heavily used and exists from beginning so, migrating from components to resources directly should be done in a phased manner.

We can use this issue to discuss different approaches for this issue.

Release Note

RELEASE NOTE:
@pravinpushkar pravinpushkar added the kind/proposal A new proposal to be considered label Dec 8, 2022
@pravinpushkar
Copy link
Contributor Author

pravinpushkar commented Dec 8, 2022 •
edited
Loading

@mukundansundar @yaron2 @shubham1172 @msfussell @artursouza

@shubham1172
Copy link
Member

Sounds good!

  1. When running a dapr init, use resources instead of components.
  2. When running dapr run, order of precedence can be resources > components. If components is used, a warning log can be added with a link to the GitHub issue with more details on the deprecation.

@mukundansundar
Copy link
Collaborator

mukundansundar commented Dec 8, 2022 •
edited
Loading

Sounds good!

  1. When running a dapr init, use resources instead of components.
  2. When running dapr run, order of precedence can be resources > components. If components is used, a warning log can be added with a link to the GitHub issue with more details on the deprecation.

Agreed with one small change.
Only when ~/.daor/components is not there, will dapr init create the ~/.dapr/resources folder.
There might be a preexisting ~/.dapr/components if dapr uninstall --all is not used before dapr init

Only when default dir is used, will the deprecation notice be printed i.e. for ~/.dapr/components dir.
Also when --components-path is used, then also a deprecation notice needs to be printed.

@shubham1172
Copy link
Member

shubham1172 commented Dec 8, 2022 •
edited
Loading

There might be a preexisting ~/.dapr/components if dapr uninstall --all is not used before dapr init

In this case, shall we warn and copy files to resources?

Also when --components-path is used, then also a deprecation notice needs to be printed.

Out of scope for this issue?

@pravinpushkar
Copy link
Contributor Author

Out of scope for this issue?

It is being covered in #1012

@pravinpushkar
Copy link
Contributor Author

Based on the above suggestions -

  1. When User just upgrades his dapr cli without uninstalling -> all usage of dapr run --components-path "" will start giving deprecation message but continues to work.
  2. User does dapr init after dapr uninstall or dapr uninstall --all -> Create resources directory always and copy the files from components directory if components dir exists.
  3. In all cases dapr run without either of the above flags, will default to looking resources dir first then components dir.

@mukundansundar
Copy link
Collaborator

Based on the above suggestions -

  1. When User just upgrades his dapr cli without uninstalling -> all usage of dapr run --components-path "" will start giving deprecation message but continues to work.
  2. User does dapr init after dapr uninstall or dapr uninstall --all -> Create resources directory always and copy the files from components directory if components dir exists.
  3. In all cases dapr run without either of the above flags, will default to looking resources dir first then components dir.

this looks good to me.
@yaron2 thoughts?

This was referenced Dec 8, 2022
Closed
Closed
@pravinpushkar
Copy link
Contributor Author

/assign

@pravinpushkar pravinpushkar linked a pull request Dec 9, 2022 that will close this issue
Draft
3 tasks
@mukundansundar mukundansundar added this to the v1.10 milestone Dec 15, 2022
@dapr-bot
Copy link
Collaborator

This issue has been automatically marked as stale because it has not had activity in the last 30 days. It will be closed in the next 7 days unless it is tagged (pinned, good first issue, help wanted or triaged/resolved) or other activity occurs. Thank you for your contributions.

@dapr-bot dapr-bot added the stale label Jan 14, 2023
@mukundansundar mukundansundar modified the milestones: v1.10, v1.11 Jan 27, 2023
@mukundansundar mukundansundar added area/cli P1 size/S 1 week of work triaged/resolved The issue has been triaged kind/enhancement enhancement to an existing feature and removed pinned labels Feb 15, 2023
@mukundansundar
Copy link
Collaborator

Have triaged this to be completed in 1.11

@mukundansundar mukundansundar modified the milestones: v1.11, v1.12 Apr 19, 2023
@mukundansundar mukundansundar removed this from the v1.12 milestone Sep 15, 2023
@mukundansundar mukundansundar added this to the v1.13 milestone Sep 15, 2023
@mukundansundar mukundansundar modified the milestones: v1.13, v1.14 Feb 8, 2024
@antontroshin antontroshin modified the milestones: v1.14, v1.15 Jul 30, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@pravinpushkar pravinpushkar

Labels
area/cli kind/enhancement enhancement to an existing feature kind/proposal A new proposal to be considered P1 size/S 1 week of work triaged/resolved The issue has been triaged
Projects
None yet
Milestone
v1.15
Development

Successfully merging a pull request may close this issue.

Rename components directory to resources under .dapr directory pravinpushkar/cli
5 participants
@antontroshin @shubham1172 @pravinpushkar @dapr-bot @mukundansundar