Release candidate v2.6.0-rc2
Pre-releaseAdd early draft of a code-quality generator that may be executed using:
npx -p yo -p generator-web-starter@next yo web-starter:code-qualityor if you're using the current pre-release of f1 cli:
f1 init --next --sub-generator=code-qualityTesting Instructions
All sub-generator commands listed below assume usage of forumone/forumone-cli v1.7.0 or greater.
Generating a new project
f1 init --nextAs of right now, the new sub-generators generators are not incorporated into the primary project creation generator, so they will need to be executed separately using the commands below.
Generating the project manifest file
This generator will run through a series of prompts to gather overall project details and allow for configuration of:
- Git repositories
- Deployment environments
- Deployment workflows
f1 init --next --sub-generator=manifestGenerating a Buildkite pipeline.yml file
Generation of the pipeline.yml file and related dependencies may be executed using this generator, but an existing project manifest file is required from a previous execution of the manifest generator as instructed above.
f1 init --next --sub-generator=buildkite-pipelineGenerating code-quality support
Most functionality within this generator is still being added and will be fleshed out further in the next release candidate.
At this time, the web-starter:code-quality sub-generator performs the following changes within a project:
- Add configuration for a new
code-qualityDocker Compose service withindocker-compose.cli.yml - Create a
robo.ymlfile for configuration of commands within upcoming code quality tools - Create a new
.envand.env.examplefile within the top-level directory of the project- The
.envfile is not intended to be committed to enable local customization - The values within the
.envfile beside thedocker-compose.*.ymlfiles are loaded for Docker Compose commands and may be interpolated into configuration within those files.
- The
f1 init --next --sub-generator=code-quality