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

feat: event descriptions #98

Merged
merged 15 commits into from
May 14, 2020
Merged

feat: event descriptions #98

merged 15 commits into from
May 14, 2020

Conversation

zeke
Copy link
Contributor

@zeke zeke commented May 14, 2020

This PR updates the build process to extract descriptions from the events listed at https://developer.github.com/v3/activity/events/types/

Notes:

  • Supports multi-paragraph descriptions
  • HTML is converted to Markdown using turndown, following prior art from other Octokit projects
  • Links to /v3 are rewritten as fully-qualified developer.github.com URLs
  • Introduced a basic JSON schema and added ajv to validate the shape of each extracted webhook object.
  • I refactored section-to-webhook.js to make it easier to read and refine. I was also able to remove some workarounds around quoted action names that were no longer necessary.
  • Removed the workaround for pull_request.synchronize which is no longer needed.

cc @rachmari @sarahs @bswinnerton @JasonEtco

Resolves #89

@zeke zeke requested a review from gr2m May 14, 2020 20:00
@zeke zeke added the Type: Feature New feature or request label May 14, 2020
index.json Outdated
"actions": [
"completed",
"created",
"requested_action",
Copy link
Contributor

Choose a reason for hiding this comment

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

I'm looking into why this is happening

@gr2m gr2m self-assigned this May 14, 2020
index.json Outdated
"actions": [
"assigned",
"closed",
"edited",
"labeled",
"locked",
"merged",
Copy link
Contributor Author

@zeke zeke May 14, 2020

Choose a reason for hiding this comment

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

@gr2m this one got added too FYI

Copy link
Contributor

Choose a reason for hiding this comment

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

ah thanks for the pointer, merged is not a valid action

@rachmari
Copy link

@zeke I mentioned this to @gr2m and it sounded like it wouldn't impact this work significantly, but I've moved and reworked that page a bit in https://github.com/github/internal-developer.github.com/pull/6352. I'm hoping to ship that this week, but I can hold on shipping it if it will cause significant changes to your work here.

@zeke
Copy link
Contributor Author

zeke commented May 14, 2020

Thanks for the heads-up @rachmari. I will defer to Gregor's judgement on that.

@gr2m gr2m changed the title feat: extract event descriptions feat: event descriptions May 14, 2020
@gr2m gr2m merged commit 45ae4be into master May 14, 2020
@gr2m gr2m deleted the update-section-parser branch May 14, 2020 20:33
@github-actions
Copy link
Contributor

🎉 This PR is included in version 3.8.0 🎉

The release is available on:

Your semantic-release bot 📦🚀

@zeke
Copy link
Contributor Author

zeke commented May 14, 2020

That was quick! Thanks for the cleanup @gr2m 🙌

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Type: Feature New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

extract event descriptions
3 participants