Skip to content

feat: update github adapter spec #1306

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

Open
wants to merge 9 commits into
base: main
Choose a base branch
from
Open

Conversation

loopingz
Copy link
Contributor

Proposed Changes

  • Adding the missing github events for the github adapter

Signed-off-by: Remi Cattiau <remi@cattiau.com>
loopingz added 6 commits July 24, 2024 17:13
Signed-off-by: Remi Cattiau <remi@cattiau.com>
Signed-off-by: Remi Cattiau <remi@cattiau.com>
Signed-off-by: Remi Cattiau <remi@cattiau.com>
Signed-off-by: Remi Cattiau <remi@cattiau.com>
Signed-off-by: Remi Cattiau <remi@cattiau.com>
Signed-off-by: Remi Cattiau <remi@cattiau.com>
| `datacontentencoding` | Omit |
| `datacontenttype` | `application/json` |
| `dataschema` | Omit |
| `subject` | "repository.name" value |
Copy link
Collaborator

Choose a reason for hiding this comment

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

repository_ruleset.id ?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

The id is really not that useful to filter on

| `datacontentencoding` | Omit |
| `datacontenttype` | `application/json` |
| `dataschema` | Omit |
| `subject` | Omit |
Copy link
Collaborator

Choose a reason for hiding this comment

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

maybe repository.id ?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Same as first comment, we have the repository url in source, not sure we need the id in subject

| `datacontentencoding` | Omit |
| `datacontenttype` | `application/json` |
| `dataschema` | Omit |
| `subject` | "workflow_job.name" value |
Copy link
Collaborator

Choose a reason for hiding this comment

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

I wonder if workflow_job.id is better in the case of a rename?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Most of GH ui only show the name, so my assumption is name would be more useful.

I do not know if the id change or not on rename

Copy link
Collaborator

Choose a reason for hiding this comment

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

what about workflow_job.run_url?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

So run_url bring you to a page that does not even contain the info of the job, the url which is different from run_url can be derived from the id but as I dont think you can really predict the id, it seems to me like a bit fastidious to filter on. My initial guess is we want to have valuable information to ease filtering.

For example it is likely i will want to target a specific workflow name in a specific repository so filtering on both source and a startsWith on subject

| `datacontentencoding` | Omit |
| `datacontenttype` | `application/json` |
| `dataschema` | Omit |
| `subject` | "workflow.name" value |
Copy link
Collaborator

Choose a reason for hiding this comment

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

workflow_run.id?

Copy link
Collaborator

Choose a reason for hiding this comment

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

I can't figure out of "name" need to be unique or not. I'm assuming 'id' must be.
From co-pilot:
the name field in a GitHub workflow does not need to be unique. The name is used for display purposes and helps you identify the workflow in the GitHub Actions tab

Copy link
Collaborator

Choose a reason for hiding this comment

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

actually, should this be the workflow.url ?

@duglin
Copy link
Collaborator

duglin commented Aug 21, 2024

@loopingz any update on this?

Signed-off-by: Remi Cattiau <remi@cattiau.com>
@duglin
Copy link
Collaborator

duglin commented Aug 29, 2024

Conditionally approved on the 8/29 call - once the open comments are closed

Copy link

This Pull Request is stale because it has been open for 30 days with
no activity. Mark as fresh by updating e.g., adding the comment /remove-lifecycle stale.

@duglin
Copy link
Collaborator

duglin commented Oct 2, 2024

@loopingz did you want to reply to the open comments?

Copy link

github-actions bot commented Nov 2, 2024

This Pull Request is stale because it has been open for 30 days with
no activity. Mark as fresh by updating e.g., adding the comment /remove-lifecycle stale.

@duglin
Copy link
Collaborator

duglin commented Nov 20, 2024

ping @loopingz

Copy link

This Pull Request is stale because it has been open for 30 days with
no activity. Mark as fresh by updating e.g., adding the comment /remove-lifecycle stale.

@duglin
Copy link
Collaborator

duglin commented Apr 3, 2025

@loopingz any chance of getting the updates to this one done in time for next week's call?

@duglin
Copy link
Collaborator

duglin commented Jul 3, 2025

@loopingz do you think we can try to wrap this one up by next week's call?

Signed-off-by: Remi Cattiau <remi@cattiau.com>
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