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

Update output types and add some missig outputs #31

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

Vampire
Copy link
Collaborator

@Vampire Vampire commented Aug 26, 2024

Fixes #30

Copy link
Collaborator Author

Vampire commented Aug 26, 2024

This stack of pull requests is managed by Graphite. Learn more about stacking.

Join @Vampire and the rest of your teammates on Graphite Graphite

Copy link
Collaborator Author

Vampire commented Aug 26, 2024

I've had a look through the outputs and did my best to correct the types and add some missing ones in the versions present in the catalog.

But I suggest you also look through them and verify, and not just skim over my changes here, to have more confidence by 4-eyes-principle.

outputs:
committed:
type: string
type: boolean
Copy link
Member

Choose a reason for hiding this comment

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

I generally appreciate doing all of this! However, what stops me from reviewing is the amount of manual checking that we'd need to do to meaningfully review it. That's why I'd first like to:

  • implement Add CI checks #2
  • I thought about a feature that would be helpful with maintaining this catalog, but might be a bit controversial: for each input and output, let's have a GitHub Actions workflow that puts its description in the comment. It's usually what is enough to check to infer the type, and if we have this information locally and always fresh, it would speed up reviewing contributions to this repo. WDYT? (Not asking you to implement it, brainstorming for now)

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

You mean as PR-review-comments? Might not be a bad idea. Why should that be controversial?

Copy link
Member

Choose a reason for hiding this comment

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

I actually meant YAML comments since they may be easier to manage than GitHub comments.

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Oh, I see, then I'm not sure how much I like it.
This is mainly for reviewing PRs, isn't it?
So as PR comments it makes sense to me so that you do not need to look at the action's YAML manually.
But duplicating the description in the typing in an automated way, I'm not so sure.

Copy link
Member

Choose a reason for hiding this comment

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

Ok, it can be a good start to have it for PRs only. I also meant being able to quickly check if the types on the main branch are correct, but you're right it's a bit itchy.

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.

Review current output types
2 participants