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.

Sign up for GitHub

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

Jump to bottom

Add documentation for retrieving Aviary webhooks #221

Merged
merged 2 commits into from
Oct 10, 2024
Merged

Add documentation for retrieving Aviary webhooks #221

merged 2 commits into from
Oct 10, 2024

Conversation

cd-work
Copy link
Contributor

@cd-work cd-work commented Oct 9, 2024

This documents the GET /webhooks endpoint of Aviary and also adds missing warnings about persisting the token into the shell history where relevant.

@cd-work
Add documentation for retrieving Aviary webhooks
9dd3405 
This documents the `GET /webhooks` endpoint of Aviary and also adds
missing warnings about persisting the token into the shell history where
relevant.
@cd-work cd-work requested a review from a team as a code owner October 9, 2024 21:02
@cd-work cd-work requested review from maxrake and eeclfrei October 9, 2024 21:02
maxrake
maxrake requested changes Oct 9, 2024
View reviewed changes
Copy link
Contributor

@maxrake maxrake left a comment

Choose a reason for hiding this comment

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

Review for content/format is complete and there is one typo to correct. I tried following the directions in the docs and could not get my configured webhooks to show with the command as listed. Has it been tested?

docs/artifact_repositories/api.md Outdated Show resolved Hide resolved
@cd-work
Copy link
Contributor Author

cd-work commented Oct 9, 2024

I tried following the directions in the docs and could not get my configured webhooks to show with the command as listed. Has it been tested?

It's not in prod yet. We can in theory wait on prod but it was so simple I thought it wouldn't be necessary. I don't mind just holding this PR open either though.

@cd-work cd-work requested a review from maxrake October 9, 2024 22:09
@maxrake
Copy link
Contributor

maxrake commented Oct 9, 2024

It's not in prod yet. We can in theory wait on prod but it was so simple I thought it wouldn't be necessary. I don't mind just holding this PR open either though.

Ah...that explains it. I could go either way on syncing (or not) this change with a PROD release.

@cd-work
Copy link
Contributor Author

cd-work commented Oct 9, 2024

Ah...that explains it. I could go either way on syncing (or not) this change with a PROD release.

Let's just wait and get another prod release out for aviary asap. Shouldn't be that difficult.

maxrake
maxrake approved these changes Oct 9, 2024
View reviewed changes
Copy link
Contributor

@maxrake maxrake left a comment

Choose a reason for hiding this comment

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

LGTM

@cd-work
Copy link
Contributor Author

cd-work commented Oct 9, 2024

Decided to just push a new aviary release so we can get this properly tested by a second party: https://github.com/phylum-dev/aviary/pull/72.

@maxrake
Copy link
Contributor

maxrake commented Oct 10, 2024

The changes have been tested and confirmed to work now that they exist in PROD.

@cd-work cd-work merged commit ec2b652 into main Oct 10, 2024
2 checks passed
@cd-work cd-work deleted the get_webhooks branch October 10, 2024 20:18
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@maxrake maxrake maxrake approved these changes

@eeclfrei eeclfrei Awaiting requested review from eeclfrei eeclfrei is a code owner automatically assigned from phylum-dev/engineering

Assignees

@cd-work cd-work

Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@cd-work @maxrake