https://github.com/adamchainz/documentation
Documentation website
https://github.com/adamchainz/documentation
Last synced: 6 months ago
JSON representation
Documentation website
- Host: GitHub
- URL: https://github.com/adamchainz/documentation
- Owner: adamchainz
- Created: 2023-02-01T17:44:58.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2023-02-05T11:30:54.000Z (over 2 years ago)
- Last Synced: 2025-02-13T14:17:24.011Z (8 months ago)
- Size: 1.1 MB
- Stars: 0
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Welcome to CodeHerald
CodeHerald listens to events in your Github repositories and triggers actions
and integrations, based on the rules you have set up. Or, as a friend put it,
"it's an if-this-then-that for Github."
## How does it work?
1. You sign-up on CodeHerald with your Github account and select repositories
you want to integrate with.
2. You enable webhooks in some or all of those repositories.
3. You create rules to trigger actions that help you save time.
That's it! CodeHerald will trigger rules whenever an event matches a rule.
## Why would I use it?
Undoubtedly the first thought that comes to mind is "what about Github Actions?"
Indeed, Github Actions (and Workflows) is great at executing scripts and it can
listen to webhooks too. However, it comes with some limitations:
1. They have to be written in YAML. YAML event matching is limited to certain
actions. Beyond that, conditions use either template language or have to be
coded. This can be fiddly, especially if the goal is to set-up sometihng
quick. CodeHerald goal is to provide a platform to simplify this process.
2. It is easy to accidentally, or intentionally, remove, break, or stop a Github
Action from executing in a pull request. CodeHerald will trigger an action as
long as webhooks are set-up, regardless if the code changed or not (in fact,
CodeHerald does not have access to code content at all!)
3. Github Actions have to be duplicated in each repository you work with.
CodeHerald can have one rule that services events from multiple repositories.
Finally, CodeHerald is an MVP and an experiment, looking for its place under the
sun. If you're not ready to try it out, but think "Oh, I'd use this only if ..."
I would love to know the end of that sentence at julius {at} codeherald.com
## Next Steps
* Sign-up and [install](install.md) CodeHerald in your account.
* Setup your first rule by following the [quickstart](quickstart.md).