
Security News
TypeScript is Porting Its Compiler to Go for 10x Faster Builds
TypeScript is porting its compiler to Go, delivering 10x faster builds, lower memory usage, and improved editor performance for a smoother developer experience.
@gemeentenijmegen/projen-project-type
Advanced tools
This repository contains an NPM package that can be used to create a new Projen AWS CDK App project.
This repository contains an NPM package that can be used to create a new Projen AWS CDK App project.
The project type GemeenteNijmegenCdkApp
provides a number of default configurations and provides features used within our organization. There are:
This project type relies on Github secrets to be set in order for all its Github workflows to work.
Environment variable | Explanation |
---|---|
GITHUB_PROJEN_TOKEN | Projen Github personal access token |
SLACK_WEBHOOK_URL | This is the url used for the emergency workflow to publish to slack |
npx projen new --from @gemeentenijmegen/projen-project-type {type}
The following project types can be used:
cdk-app
standard CDK projectcdk-lib
standard CDK construct library (published to NPM by default)jsii-lib
a JSII application (published to NPM by default)ts-lib
a typescript project (published to NPM by default)Adding sample files to a cdk-app can be done with
npx projen new --from @gemeentenijmegen/projen-project-type cdk-app --makeSampleFiles
For instructions on how to start using the project type in existing projects there is the setup guide. Note: for switching back to the awscdk-app-ts projen project type also see the setup guide.
There are a number of relevant properties that are provided by projen
Property | Default | Explanation |
---|---|---|
cdkVersion | '2.1.0' | Minimum version of the cdk to use (upgraded using projen upgrade task) |
defaultReleaseBranch | 'main' | Should be set to acceptance |
name | project name | Sets the project name |
gitignore | A number of default ignored files are set specific to our projects | |
scripts | The cfn-lint script is added to the list of scripts configured | |
license | EUPL-1.2 | The defult license used by us |
depsUpgradeOptions | Upgrade workflow configuration (branch: acceptance , labels: cfn-diff ) |
The project type in this npm package provides some additional configuration options:
Property | Default | Explanation |
---|---|---|
enableCfnLintOnGithub | true | Enable step in the Github build workflow that runs cfn-lint |
enableEmergencyProcedure | true | Adds the emergency procedure workflow to Github workflows |
enableAutoMergeDependencies | true | Adds the auto-merge workflow for PR's to acceptance (from upgrade workflow) |
De upgrade dependencies task en Github workflow zijn standaard enabled. Deze task zal de laatste versies van de dependencies zoeken (volgens semantic versionioning) en upgraden in de package.json
.
Dit project type zet de default branch voor het uitvoeren van de workflow op acceptance
.
De Github workflow voert de upgrade dependencies taak uit en maakt een PR naar acceptance
en geeft het PR een label cfn-diff
en auto-merge
.
De automerge workflow gaat af als een PR acceptance
als base heeft en het label auto-merge
heeft. Deze probeert het PR te mergen met de auto-merge
feature van Github. Hiervoor moet in het Github-project automerge aan staan. NB: Zorg dat branch protection aan staat voor acceptance, met de eis dat aan
alle voorwaarden voldaan is. Anders kan de auto-merge worden uitgevoerd voordat de build succesvol is.
De upgrade dependencies taak in projen is inclusief de CDK versie. Hiervoor wordt de minimum versie in de .projenrc.js
van een project ingesteeld.
Dit betekent dat:
cdkVersion: '2.1.0
gebruikt wordt in de .projenrc.js
dit in de package.json
wordt geimporteerd als "aws-cdk-lib": "^2.1.0"
package.json
wordt geupdate naar bijv: "aws-cdk-lib": "^2.31.0"
De projen versie wordt ook geupgrade in de upgrade dependencies task.
One can locally test project creation using this package by running
# Run the extract command on this project
cd /path/to/the/package/modules-projen && npx projen extract
# Create a new test project
mkdir test-project
cd test-project
npx projen new --from file://path/to/the/package/modules-projen/dist/js/package cdk-app
FAQs
This repository contains an NPM package that can be used to create a new Projen AWS CDK App project.
The npm package @gemeentenijmegen/projen-project-type receives a total of 774 weekly downloads. As such, @gemeentenijmegen/projen-project-type popularity was classified as not popular.
We found that @gemeentenijmegen/projen-project-type demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 0 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
TypeScript is porting its compiler to Go, delivering 10x faster builds, lower memory usage, and improved editor performance for a smoother developer experience.
Research
Security News
The Socket Research Team has discovered six new malicious npm packages linked to North Korea’s Lazarus Group, designed to steal credentials and deploy backdoors.
Security News
Socket CEO Feross Aboukhadijeh discusses the open web, open source security, and how Socket tackles software supply chain attacks on The Pair Program podcast.