You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+8-2Lines changed: 8 additions & 2 deletions
Original file line number
Diff line number
Diff line change
@@ -78,18 +78,20 @@ Boosts are stored by default in `~/.codeboost/boosts`, and examples can be found
78
78
79
79
## Configuration
80
80
81
-
To use the `codeboost` CLI, create a file named `codeboost.config.js` in your current working directory or run `codeboost init` to create a default configuration file.
81
+
To use the [`codeboost` CLI](./docs/cli.md), create a file named `codeboost.config.js` in your current working directory or run `codeboost init` to create a default global configuration file.
82
82
83
83
The default configuration file is stored in `~/.codeboost/codeboost.config.js`. This file assumes that you have an environment variable named `CODEBOOST_GITHUB_TOKEN` that contains a valid GitHub personal access token with the `repo` scope. You may edit this file to use a different token or to change the default storage paths.
84
84
85
-
This file should export a `default` configuration object with the following properties:
85
+
The configuration file should export a `default` configuration object with the following properties:
86
86
87
87
```typescript
88
88
exportinterfaceAppSettings {
89
89
github_token:string;
90
90
repository_storage_path:string;
91
91
boosts_path:string;
92
+
// create fork of each repository
92
93
use_forks:boolean;
94
+
// create pull request for each repository
93
95
use_pull_requests:boolean;
94
96
log_target:'console'|'file';
95
97
}
@@ -111,6 +113,10 @@ module.exports.default = {
111
113
> Note that the `github_token` property can be set to a string value or an environment variable name prefixed with a '$'.
112
114
> If the value is an environment variable name, the value of the environment variable will be used.
113
115
116
+
If you are working on repositories that you have push access to and don't want to create forks or pull requests, you can set the `use_forks` and `use_pull_requests` properties to `false`. This will cause `codeboost` to commit directly to the main branch of the repository.
117
+
118
+
If you disable `use_forks` but not `use_pull_requests`, a separate branch will be created on the repository and a pull request will be created for that branch. Enabling `use_forks` automatically enables `use_pull_requests`.
0 commit comments