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

Support custom action for automation rules with webhook + api #6375

Open
stsewd opened this issue Nov 13, 2019 · 0 comments
Open

Support custom action for automation rules with webhook + api #6375

stsewd opened this issue Nov 13, 2019 · 0 comments
Labels
Feature New feature Needed: design decision A core team decision is required Sprintable Small enough to sprint on

Comments

@stsewd
Copy link
Member

stsewd commented Nov 13, 2019

Currently, the actions to be run are only defined in code

https://github.com/readthedocs/readthedocs.org/blob/master/readthedocs/builds/automation_actions.py

Users can't set a custom action. We don't want to execute arbitrary code neither. But we can offer users to set a webhook that will be called on a match. Users can use apiv3 to do whatever they want to the version or project.

Why don't just use api?

Because users don't have a way to know when the version is created on rtd (nor the final slug). They can only know when the version is created on github.

Examples

The webhook receives a payload with the project and the matched version. Then the user can trigger a build or deactivate the version or modify other versions, anything.

@stsewd stsewd added Needed: design decision A core team decision is required Feature New feature labels Nov 13, 2019
@humitos humitos added the Sprintable Small enough to sprint on label Jan 25, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Feature New feature Needed: design decision A core team decision is required Sprintable Small enough to sprint on
Projects
None yet
Development

No branches or pull requests

2 participants