https://github.com/linear-b/gitstream-github-action
/:\ gitStream - Workflow GitHub Action
https://github.com/linear-b/gitstream-github-action
automation ci-cd cm-ci-cd github githubaction-workflow productivity
Last synced: 6 days ago
JSON representation
/:\ gitStream - Workflow GitHub Action
- Host: GitHub
- URL: https://github.com/linear-b/gitstream-github-action
- Owner: linear-b
- License: apache-2.0
- Created: 2022-08-11T14:56:26.000Z (over 3 years ago)
- Default Branch: develop
- Last Pushed: 2026-04-12T12:50:23.000Z (7 days ago)
- Last Synced: 2026-04-12T14:25:58.762Z (7 days ago)
- Topics: automation, ci-cd, cm-ci-cd, github, githubaction-workflow, productivity
- Language: JavaScript
- Homepage:
- Size: 134 MB
- Stars: 6
- Watchers: 4
- Forks: 11
- Open Issues: 12
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# gitStream GitHub Action
This GitHub Action enables you to use the gitStream Continuous Merge (CM) script
in your repositories to automate code review workflows. The gitStream CM script
allows you to define custom automations that run whenever someone opens a new
pull request (PR) or makes changes to an existing PR.
## How gitStream Works
gitStream can be configured through one or more CM files inside your git
repository or GitHub/GitLab organization. These CM files, ending with a `.cm`
extension, contain YAML and Jinja2 code that outlines the rules for triggering
and executing automations. The "if this, then that" approach combined with
templating and gitStream-specific functions offers a highly flexible framework
for building custom CM automations.
## Next Steps
If you're ready to start writing automations, check out our guide:
[Write Your First Automation](https://docs.gitstream.cm/quick-start/).
## Reporting Issues
If you encounter any issues with gitStream or these documentation, please check
the [gitStream issues page](https://github.com/linear-b/gitstream/issues) and
create a new issue if it doesn't already exist. We appreciate your feedback and
help in improving gitStream!
## Syntax Highlighting
To add support for `.cm` files in your code editor, see our
[FAQ](https://docs.gitstream.cm/faq/#is-there-cm-syntax-highlighting).
## Managing Dependencies
### Action dependencies (`package.json` → `dependencies`)
Imported by the action's source code. Must be listed in `package.json` for build time.
To add:
1. `npm install ` and import it in `src/`
2. If it can't be bundled by ncc (WASM, native addons), add `--external ` to the `package` script and add it to `vendor-plugins` as well
### Plugin dependencies (`vendor-plugins` script in `package.json`)
Packages that user plugins can `require()` at runtime. Installed into `dist/node_modules/` at build time and committed to the repo.
To add:
1. Add with a pinned version to the `vendor-plugins` script in `package.json`
2. Run `npm run package` and commit the updated `dist/node_modules/`
## License
The gitStream GitHub Action is licensed under the Apache License. See
[LICENSE](LICENSE) for more details.