Skip to content
This repository was archived by the owner on Mar 25, 2022. It is now read-only.

Release candidate v2.6.0-rc2

Pre-release
Pre-release

Choose a tag to compare

@slucero slucero released this 22 Oct 18:50

Add early draft of a code-quality generator that may be executed using:

npx -p yo -p generator-web-starter@next yo web-starter:code-quality

or if you're using the current pre-release of f1 cli:

f1 init --next --sub-generator=code-quality

Testing Instructions

All sub-generator commands listed below assume usage of forumone/forumone-cli v1.7.0 or greater.

Generating a new project

f1 init --next

As 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=manifest

Generating 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-pipeline

Generating 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-quality Docker Compose service within docker-compose.cli.yml
  • Create a robo.yml file for configuration of commands within upcoming code quality tools
  • Create a new .env and .env.example file within the top-level directory of the project
    • The .env file is not intended to be committed to enable local customization
    • The values within the .env file beside the docker-compose.*.yml files are loaded for Docker Compose commands and may be interpolated into configuration within those files.
f1 init --next --sub-generator=code-quality