User guide

This chapter describes how the user (packager) can interact with The New Hotness.

Notifications settings

The notifications settings for The New Hotness can be set by creating file monitoring.toml in dist git. If the file is missing the legacy settings will be checked (when we move dist-git to forgejo the monitoring will be treated as disabled in this case).

Note

The setting doesn’t matter if the project is not created in Anitya.

Following is an example monitoring.toml file with default values.

# Enable/disable monitoring
monitoring = false
# Enable/disable filling bugzilla ticket for new release
# When disabled it will also disable scratch builds
bugzilla = true
# Enable/disable reporting only stable versions
# Stable versions are recognized based on release-monitoring.org project settings
stable_only = false
# Enable/disable reporting all new versions instead of the latest one
# Enabling this will disable scratch builds
all_versions = false
# Enable/disable scratch build for newly opened version
scratch_build = false

Notifications settings (legacy)

Note

This approach will be supported for legacy reasons, but the new approach is preferred as it not depends on hosting platform.

The notifications settings for The New Hotness can be set in the dist git. The option is available for each package as Monitoring status option on the left side of the package repository site.

Note

The setting doesn’t matter if the project is not created in Anitya.

Following is the explanation of the Monitoring status options:

  • No-Monitoring - Project will not be monitored and The New Hotness will drop any update for this project

  • Monitoring - Project will be monitored by The New Hotness and Bugzilla ticket will be created each time a new version will be discovered by Anitya.

  • Monitoring and scratch builds - Project will be monitored by The New Hotness and Bugzilla notification will be created each time a new version will be discovered by Anitya. Additionally a scratch build will be started for the new version.

  • Monitoring all - Project will be monitored by The New Hotness and Bugzilla notification will be created for every version that will be discovered by Anitya. This could cause issues with duplicates in case the version will be deleted and retrieved again in Anitya.

  • Monitoring all and scratch builds - Project will be monitored by The New Hotness and Bugzilla notification will be created for every version that will be discovered by Anitya. Additionally a scratch build will be started for the newest version retrieved, if the version is newer than the one already available in mdapi. This could cause issues with duplicates in case the version will be deleted and retrieved again in Anitya.

  • Monitoring stable only - Project will be monitored by The New Hotness and Bugzilla ticket will be created each time a new stable version will be discovered by Anitya. In case multiple versions are reported at once, newest stable will be used.

  • Monitoring stable only and scratch builds - Project will be monitored by The New Hotness and Bugzilla notification will be created each time a new stable version will be discovered by Anitya. In case multiple versions are reported at once, newest stable will be used. Additionally a scratch build will be started for the new version.

Creating a project in Anitya

For The New Hotness to function properly there have to be a project in Anitya. For the information how to create a new project, look at the user guide in Anitya documentation.

Opening pull requests in dist-git

Thanks to the work of Packit Team it is now possible to have pull requests filed directly in dist git when a new update is detected by The New Hotness for a monitored project.

The process is described in Packit documentation and needs the package to have monitoring enabled and be set up in Anitya.