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

Chore: Add naming conventions to documentation #189

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

Conversation

ModeSevenIndustrialSolutions
Copy link
Contributor

@ModeSevenIndustrialSolutions ModeSevenIndustrialSolutions commented Oct 9, 2024

Will pass linting if/when we merge: #188

README.md Outdated
| --------------- | ---------------- | ---------------------- |
| [GV] | Gerrit (Verify) | gerrit-verify.yaml |
| [GM] | Gerrit (Merge) | gerrit-merge.yaml |
| [G] | Gerrit (Generic) | [either of the above] |
Copy link
Member

Choose a reason for hiding this comment

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

The Generic really should be listing a filename that is gerrit-<something>.yaml as we do technically actually support other types, just nobody is doing so in practice right now. To be specific this would be used for custom magic comment keyword triggers.

Copy link
Member

@tykeal tykeal left a comment

Choose a reason for hiding this comment

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

I know I'm being a little pedantic, but I would like the idea around the generic Gerrit workflows to be reworked. See my comment in the file itself.

| Description | Directory Suffix |
| ----------- | ---------------- |
| Composite | -action |
| Javascript | -javascript |
Copy link
Member

Choose a reason for hiding this comment

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

To be specific this should be Typescript, not Javascript (related, but not exactly the same)


Discussion Points (on the table above)

We could locate deployed workflows in a separate folder structure from
Copy link
Member

Choose a reason for hiding this comment

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

IIRC workflows must live under the workflows directory even if they're called by another workflow. If I'm not correct, can you point me to documentation or working example of being able to call them from someplace else?

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.

2 participants