Skip to content

Commit 82538d1

Browse files
authored
docs: add note on location of configs (#66)
1 parent 201e982 commit 82538d1

1 file changed

Lines changed: 8 additions & 0 deletions

File tree

README.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -186,6 +186,14 @@ Managed by release-please: ([conventional commits](https://www.conventionalcommi
186186
├── .editorconfig # Ensures consistent code style across editors
187187
└── .gitignore
188188
```
189+
Note that while it is common practice to keep the config files at the root of the
190+
repository, and this is what I recommend, it is possible to customise the
191+
location of some of them if you prefer
192+
(e.g. the path to `release-please-config.json` [can be specified in the
193+
release-please.yaml file for the GitHub action]
194+
(https://github.com/googleapis/release-please-action?tab=readme-ov-file#advanced-release-configuration)
195+
and the path to the `mkdocs.yaml` [can be configured using the `--config-file` option](https://www.mkdocs.org/user-guide/configuration/)
196+
and setting the path in the `.readthedocs.yaml` file.)
189197

190198
## 🤝 Contributing
191199

0 commit comments

Comments
 (0)