Template repository for Gemeente Nijmegen cdk projects

After completing the instructions in this REAMDE replace the file with a project relevant readme.

Getting started

This repository can be used as a Github template to start new cdk projects for Gemeente Nijmegen.

1. Setup workflow configuration

It is important to configure a personal access token as a Github workflow secret.

• Create a new personal access token under your account settings
  • Settings > Developer settings > Perosnal access tokens
  • Allow all repo rights and allow workflow rights
• Copy the personal access code
• Create a workflow secret in the repository called PROJEN_GITHUB_TOKEN and paste your personal access token in there.

Note: this can be dangerous as everybody with write access to the repository can now acces your personal access token. (A PR from a fork will not have acces to the workflow secrets.)

2. Branch protection

Github does not include branch protection configuration while using a repository as a template.

Recommended branch protection:

• Branch production
  • Require a pull request before merging
    • Require approvals
  • Require status checks to pass before merging
    • build (workflow)
    • pull-request-lint (workflow)
  • Include administrators

3. First release

Current releases are v0.*. For a first release to do a major version bump increase the major version in .projenrc from 0 to 1.