Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Binary file removed temp_backup/images/freight.jpg
Binary file not shown.
Binary file removed temp_backup/images/freight.png
Binary file not shown.
247 changes: 0 additions & 247 deletions temp_backup/readme.md

This file was deleted.

2 changes: 1 addition & 1 deletion website/docs/advanced.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Advanced Configuration
npm # Advanced Configuration

Take full control of your Git hooks with advanced configuration options and deep dives into Freight's execution model.

Expand Down
3 changes: 1 addition & 2 deletions website/docs/best-practices.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,10 +3,9 @@
Follow these guidelines to ensure a smooth and consistent experience for your entire team using Freight.

### Version Control
It is crucial to commit both the `railcar.json` configuration file AND the `conductor` binary to your repository.
It is crucial to commit the `railcar.json` configuration file.

* **railcar.json**: Defines what hooks run and what they do.
* **conductor**: Ensures everyone is using the exact same orchestrator version without needing to install external dependencies like Node.js or Python.

:::info
By committing the binary, you guarantee that Git hooks will work immediately upon cloning the repository, regardless of the developer's local environment.
Expand Down
3 changes: 0 additions & 3 deletions website/docs/installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -65,9 +65,6 @@ freight init --allow pre-commit,commit-msg

This is particularly useful for **incremental adoption**. If you already have a complex set of hooks and only want to move `pre-commit` to Freight for now, you can do so without affecting your other hooks.

:::tip Pro-Tip
For total team portability, **commit the `conductor` binary** directly to your repository. This ensures that every team member (and your CI/CD pipeline) can execute hooks immediately without needing to install the `freight` CLI tool themselves.
:::

### 3. Verify
Add a simple command to your `railcar.json` and trigger a hook:
Expand Down
Loading
Loading