https://github.com/permafrost-dev/template-configuration-script
A script for customizing repositories created from template repositories.
https://github.com/permafrost-dev/template-configuration-script
configuration customization repository-utilities script template-repository
Last synced: 11 months ago
JSON representation
A script for customizing repositories created from template repositories.
- Host: GitHub
- URL: https://github.com/permafrost-dev/template-configuration-script
- Owner: permafrost-dev
- License: mit
- Created: 2022-02-06T19:06:07.000Z (about 4 years ago)
- Default Branch: main
- Last Pushed: 2023-11-21T11:57:04.000Z (about 2 years ago)
- Last Synced: 2025-01-23T15:31:54.648Z (about 1 year ago)
- Topics: configuration, customization, repository-utilities, script, template-repository
- Language: TypeScript
- Homepage:
- Size: 123 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 8
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: .github/CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Security: .github/SECURITY.md
Awesome Lists containing this project
README
# template-configuration-script
Script included in [Permafrost Software](https://github.com/permafrost-dev) template repositories for customization.
Some of the optional features included in this script are:
- Use of the [codecov.io](https://codecov.io) service to report coverage.
- Use of Dependabot to automatically update dependencies.
- Automatically merging Dependabot pull requests.
- Use of CodeQL to analyze code quality.
---
## Description
The compiled script prompts the user for some configuration options, which are used to replace the placeholders in several files.
- project name;
- project description;
- name, email and github username of the author;
- name and github username of the project's owner/organization;
The default values for the configuration prompts are intelligently guessed using several sources, such as the local git configuration and the GitHub API.
## Setup
```bash
npm install
npm run build
```
This will generate the compiled script in `dist/configure-template.js`.
## Testing
`template-configuration-script` uses Jest for unit tests. To run the test suite:
`npm run test`
---
## Changelog
Please see [CHANGELOG](CHANGELOG.md) for more information on what has changed recently.
## Contributing
Please see [CONTRIBUTING](.github/CONTRIBUTING.md) for details.
## Security Vulnerabilities
Please review [our security policy](../../security/policy) on how to report security vulnerabilities.
## Credits
- [Patrick Organ](https://github.com/patinthehat)
- [All Contributors](../../contributors)
## License
The MIT License (MIT). Please see [License File](LICENSE) for more information.