https://github.com/chassis/gitignore
Add specific lines from your config.local.yaml to the .git/info/exclude file in the Chassis repo checkout.
https://github.com/chassis/gitignore
Last synced: 8 months ago
JSON representation
Add specific lines from your config.local.yaml to the .git/info/exclude file in the Chassis repo checkout.
- Host: GitHub
- URL: https://github.com/chassis/gitignore
- Owner: Chassis
- Created: 2020-06-12T18:44:06.000Z (about 6 years ago)
- Default Branch: main
- Last Pushed: 2020-06-12T20:07:27.000Z (about 6 years ago)
- Last Synced: 2025-03-11T00:05:42.442Z (over 1 year ago)
- Language: Puppet
- Size: 2.93 KB
- Stars: 0
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Gitignore Chassis Extension
This [Chassis extension](https://docs.chassis.io/en/latest/extend/) lets you specify a list of strings that will be appended to the [`.git/info/exclude` file within the Chassis repository's root directory](https://git-scm.com/docs/gitignore). This lets you augment Chassis' own [`.gitignore` rules](https://github.com/Chassis/Chassis/blob/master/.gitignore) to include files (such as generated keys) which should not appear in any diff or git status check performed on the Chassis checkout.
This can improve housekeeping within your Chassis checkout, but should be unnecessary for the majority of Chassis sites.
## Usage
1. Clone this into the `extensions` folder of your Chassis installation, or list `gitignore` in your [Chassis configuration file's extensions list](https://docs.chassis.io/en/latest/config/#extensions).
2. Specify one or more items in a `gitignore:` list within your [configuration file](https://docs.chassis.io/en/latest/config/), as in the example below.
3. Run `vagrant up` if you have not yet initialized your virtual machine, or `vagrant provision` if your VM is already up and running.
Any `git diff` or `git status` command run within the Chassis repository checkout should now exclude the patterns listed in your configuration file.
## Example
Exclude `.key` files in your Chassis directory, and a specific individual file, from the Chassis git repository checkout.
```yaml
# config.local.yaml
gitignore:
- '*.key'
- 'some-specific-file-to-exclude.txt'
```