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

Consider removing "project" variable #9

Open
vsoch opened this issue Mar 6, 2020 · 1 comment
Open

Consider removing "project" variable #9

vsoch opened this issue Mar 6, 2020 · 1 comment

Comments

@vsoch
Copy link
Contributor

vsoch commented Mar 6, 2020

As discussed in #6 (review) with @Beanow, we could very easily remove the need to specify a project identifier (the project action variable) that is needed to run sourcecred scores if we can parse it directly from the file. Some points to think about:

  • the project id would likely always be supported in the action, and used if the user provides it (and we would skip parsing)
  • if no project id is provided and the file just has one, we can use what we find when we parse
  • if no project id is provided and more than one are found, we would need to throw an error.

This likely won't go into the first round of edits, as I think it requires more work/ discussion (or maybe me just knowing about) the format for this project file. But definitely let's keep it on the radar for the future.

@Beanow
Copy link
Collaborator

Beanow commented Mar 6, 2020

Seeing how this is fairly inconsistent in the SourceCred CLI (and that's a clear smell), I would not put too much work into a permanent solution in the action. It will likely be changed in SC itself.

My preference for the next SC release would be to move to a notion of "SourceCred instances" where there is always exactly 1 project. Meaning the ID for projects becomes obsolete.

Though, because it would become obsolete, I do suggest trying to create the action's interface with exactly 1 project in mind. So removing the ID from the arguments if we can easily do so would be great :]

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

No branches or pull requests

2 participants