@verkstedt/setup-repo
v1.1.9
Published
Set up a checked out repository just the way we like it.
Readme
@verkstedt/setup-repo
Set up a checked out repository just the way we like it.
Warning: Comes with verkstedt–specific hard–coded values.
Links
Usage
cd ~/src/@verkstedt/some-project/
npx @verkstedt/setup-repo@latest .What does it do?
- Metadata and docs:
- Sync package name, description, keywords and homepage between
package.json,README.mdand GitHub repo - Sync license between
package.json,LICENSEfile andREADME.md - Create “Links” section in
README.md, if it doesn’t exist
- Sync package name, description, keywords and homepage between
- GitHub workflows from
verkstedt/actionsci,ref-by-commit,jira,create-release- For frontend projects, also
chromatic - Make sure required GitHub actions vars and secrets are set
- GitHub settings
- Disable or enable Issues tab, depending whether repo is public
- Disable tabs: Wiki, Projects
- Enable auto–merge
- Delete branch after it’s merged
- Merge PRs via merge commits
- Give everybody
maintainpermission - Make sure there’s a
CODEOWNERSfile withpackage-lock.json - Dependabot configuration from
verkstedt/.github - Set up protection ruleset for main branch and version tags
TODO
General
- [ ] Disable “Models” tab
- [ ] Templates: pull request, commit
- [ ] Error handling: Currently we ignore lot of shell output
- [ ] Error handling: Don’t exit, if user doesn’t have permissions to do stuff on GitHub
- [ ] Test (with mock
ghcommand) - [ ] Move stuff out of shell to JavaScript
- [ ] Switch to
spawnSyncfor better arg escaping - [ ] Use GitHub API, when
ghis not available
README
- [ ] Quick start (
npm run dev)
NPM
- [ ] Sort keys in
package.json - [ ] Install storybook and chromatic
- [ ] Linters and npm scripts
Chromatic
- [ ] Is there an API for this? Or maybe we can use playwright or something?
- [ ] Disable “Review UI”
- [ ] Enable “Accessibility tests”
