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

Think about a better name for the RepositoryConfiguration class #4466

Closed
sschuberth opened this issue Sep 16, 2021 · 8 comments
Closed

Think about a better name for the RepositoryConfiguration class #4466

sschuberth opened this issue Sep 16, 2021 · 8 comments
Labels
enhancement Issues that are considered to be enhancements model About the data model

Comments

@sschuberth
Copy link
Member

While the class is named RepositoryConfiguration, it is actually documented to apply to projects:

/**
* A project specific configuration for ORT which is usually stored in [ORT_REPO_CONFIG_FILENAME] at the root of a
* repository. It will be included in the analyzer result and can be further processed by the other tools.
*/
data class RepositoryConfiguration(

In general, the class should probably named after the entity the configuration applies to, not after where it is stored.

Please add some proposals for a better name to this issue. To start with, here are some ideas from the ORT developer meeting:

(See below, in separate comments each, so people can vote via reaction on the comment.)

@sschuberth
Copy link
Member Author

ProjectConfiguration

@sschuberth
Copy link
Member Author

OrtResultConfiguration

@sschuberth
Copy link
Member Author

DistributionConfiguration

@sschuberth
Copy link
Member Author

ModuleConfiguration

@sschuberth sschuberth added enhancement Issues that are considered to be enhancements model About the data model labels Sep 16, 2021
@sschuberth sschuberth changed the title Think about better names for the RepositoryConfiguration class Think about a better name for the RepositoryConfiguration class Sep 16, 2021
@sschuberth
Copy link
Member Author

ProductConfiguration

@fviernau
Copy link
Member

ArtifactConfiguration

@fviernau
Copy link
Member

ReleaseArtifactConfiguration

@sschuberth
Copy link
Member Author

Closed as part of backlog grooming. Feel free to comment if you would like to contribute to this.

@sschuberth sschuberth closed this as not planned Won't fix, can't repro, duplicate, stale Jun 24, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement Issues that are considered to be enhancements model About the data model
Projects
None yet
Development

No branches or pull requests

2 participants