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

Include a section explaining how Ballerina dependency "testOnly" is inferred during the dependency resolution #8652

Closed
ShammiL opened this issue Feb 6, 2024 · 3 comments
Assignees
Labels
Area/LearnPages Issues related to all the pages of the Learn section. Category/Content All written content related issues (Technical content, english language etc) Type/Improvement Improvements required on the website.

Comments

@ShammiL
Copy link
Contributor

ShammiL commented Feb 6, 2024

Description

Although the documentation(https://ballerina.io/learn/test-ballerina-code/configure-tests/#define-test-only-dependencies) specifies how testOnly scope can be assigned for platform dependencies, it does not mention anywhere how Ballerina dependency scopes are assigned.
It would be more informative to have a section explaining how testOnly scope is inferred for during the dependency resolution stage. This can be included under the "Manage Dependencies" section.

Related website/documentation area

Add/Uncomment the relevant area label out of the following.

Area/LearnPages

Describe the problem(s)

A detailed description of the purpose of this improvement.

Describe your solution(s)

A detailed description of how this improvement will solve the problem described above.

Related issue(s) (optional)

Any related issues such as sub tasks and issues reported in other repositories (e.g., component repositories), similar problems, etc.

Suggested label(s) (optional)

Optional comma-separated list of suggested labels. Non committers can’t assign labels to issues, and thereby, this will help issue creators who are not a committer to suggest possible labels.

Suggested assignee(s) (optional)

Optional comma-separated list of suggested team members who should attend the issue. Non committers can’t assign issues to assignees, and thereby, this will help issue creators who are not a committer to suggest possible assignees.

@ShammiL ShammiL added Type/Improvement Improvements required on the website. Area/LearnPages Issues related to all the pages of the Learn section. labels Feb 6, 2024
@anupama-pathirage
Copy link
Contributor

@Dilhasha What is the status of this? Can we prioritize this ? Can we add this to update 9 related content and get it completed by update 9?

@anupama-pathirage anupama-pathirage added the Category/Content All written content related issues (Technical content, english language etc) label Apr 2, 2024
@Dilhasha
Copy link
Contributor

Dilhasha commented Apr 3, 2024

@Dilhasha What is the status of this? Can we prioritize this ? Can we add this to update 9 related content and get it completed by update 9?

I'll prioritize this.

@Dilhasha Dilhasha assigned Dilhasha and unassigned azinneera Apr 3, 2024
@Dilhasha
Copy link
Contributor

Dilhasha commented Apr 3, 2024

We infer ballerina dependencies as testOnly if the dependencies are used only within test source files and we don't allow users to set the scope explicitly.
Hence, we decided not to add this information to the documentation as it doesn't add any value to the users and might even confuse users.

@Dilhasha Dilhasha closed this as completed Apr 3, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Area/LearnPages Issues related to all the pages of the Learn section. Category/Content All written content related issues (Technical content, english language etc) Type/Improvement Improvements required on the website.
Projects
Archived in project
Development

No branches or pull requests

4 participants