23 docs tagged with "configuration"

The changelog section is where you configure the (optional) changelog generation.

Here are a few examples of using a combination of Nyx flavors together in the same build process.

Commit message conventions are patterns used for Git commit messages widely used in software development. To name a few: Conventional Commits, Angular, Karma, jQuery, JSHint, Ember, gitmoji. While discussing these conventions is out of scope for this page, what is important here is that you can configure Nyx with any convention in order to fetch information directly from the commit messages (like, for example, the version number to bump after a certain commit).

Nyx offers a wide range of configuration options, including:

Configuration presets are the easiest way to get started with Nyx as they bring streamlined configurations ready to use with just one option to configure.

This section give you a detailed reference on Nyx configuration and command line options.

Although you can configure Nyx by means of static values, you also have the option to use templates to make them dynamic.

This preset can be used by setting the preset global configuration option value to extended and brings rich standard configurations suitable for projects with several options in place.

Here you can find the example of a large configuration in the supported formats.

The git section is where you can pass Git parameters to Nyx.

In this page you can find some examples of Git histories. To the sake of simplicity, these examples do not use a specific commit message convention but, instead, they just show the kind of commit that would be inferred by a convention. Semantic Versioning is the version scheme used.

These are the top level options in the configuration:

Here you can find the example of a medium complexity configuration in the supported formats.

Release assets are the artifacts to be attached to releases upon publication. These may be local files (produced during the build process) or remote URLs. The configuration allows using dynamic templates so you can have multiple degrees of control over the released contents.

Release types are definitions that allow conditional settings to be used depending on what Nyx is releasing and how. The configuration allows using dynamic values that can also be used as conditionals so you can have multiple degrees of control over the released contents.

Services are objects performing additional operations to be plugged in the overall workflow. They may support one or more features and they are invoked by specific configurations. The points where a service can be invoked from depend on the features they provide so for each invocation point the list of required features is outlined. Example services are those used to publish releases on Git hosting service like GitHub and GitLab or produce artifacts using templates.

This preset can be used by setting the preset global configuration option value to simple and brings standard configurations well suited to get started with common items, as follows.

Here you can find the example of the a simple configuration in the supported formats.

Here you can find the example of the simplest configuration in the supported formats.

Substitutions are used to replace arbitrary text tokens in any text file with static or dynamic contents.

Templates can be used in several places to make configuration dynamic or parametrize text outputs, be them strings, messages or even whole text files.

When you use the version project property and it yields to the unspecified value although you expected it to be something else the reason may be:

One of the very first steps when running a pipeline on a CI/CD platfom is checking out the Git repository and this is usually done by the platform without the user to define any specific configuration or workflow.