Contributing

The New Hotness welcomes contributions! This document should help you get started. The New Hotness is using Clean Architecture Design, the implementation details are in Clean architecture design.

Contribution Guidelines

When you make a pull request, a Fedora Infrastructure team member will review your code. Please make sure you follow the guidelines below:

Code style

We follow the PEP8 style guide for Python. The test suite includes a test that enforces the required style, so all you need to do is run the tests to ensure your code follows the style. If the unit test passes, you are good to go!

We are using Black <https://github.com/ambv/black> to automatically format the source code. It is also checked in CI. The Black webpage contains instructions to configure your editor to run it on the files you edit.

Unit tests

All unit tests must pass. All new code should have 100% test coverage. Any bugfix should be accompanied by one or more unit tests to demonstrate the fix. If you are unsure how to write unit tests for your code, we will be happy to help you during the code review process.

Development environment

Using Vagrant

The best way to set up a development enviroment is to use Vagrant. To get started, install Vagrant:

$ sudo dnf install vagrant libvirt vagrant-libvirt vagrant-sshfs ansible

Next, clone the repository and configure your Vagrantfile:

$ git clone https://github.com/fedora-infra/the-new-hotness.git
$ cd the-new-hotness
$ vagrant up
$ vagrant ssh

Before you can run the-new-hotness, you need to add your bugzilla credentials to the configuration. You can set these credentials in ~/config.toml in the virtual machine.

You also need to acquire a valid Kerberos ticket to perform Koji scratch builds. You can get this by performing kinit <fas-username>@FEDORAPROJECT.ORG. When using two-factor authentication, please follow official fedora guide.

Warning

Services will fail to start if you do not provide valid credentials.

You now have a functional development environment. The message of the day for the virtual machine has some helpful tips, but the basic services can be started in the virtual machine with:

$ systemctl --user start hotness.service

Log output is viewable with journalctl --user-unit hotness.service.

You can also use aliases:

hotstart - start the-new-hotness hotstop - stop the-new-hotness hotlog - show log of the-new-hotness

For other aliases look in the ~/.bashrc file.

Using Docker / Podman

Using Docker you will be able to control each service (hotness app, RabbitMQ, Redis, etc.) separately. You can turn off Redis or RabbitMQ or both, then connect to external services or use them with the application.

Requirements:

  • Docker + Docker Compose or

  • Podman + Podman Compose

Next, clone the repository and start containers:

$ git clone https://github.com/fedora-infra/the-new-hotness.git
$ cd the-new-hotness
$ make up

Hotness container starts after the start of containers running services required by the-new-hotness. Usually, it takes around 10-30 seconds depends on the computer power.

Container Service Informations:

Name 1

Url

Credentials

RabbitMQ

http://localhost:5672

hotness:hotness

RabbitMQ Management UI

http://localhost:15672

hotness:hotness

Redis

http://localhost:6379

not required

Makefile scripts that provide easier container management:

  • make up Starts all the container services

  • make restart Restarts all the container services that are either stopped or running

  • make halt Stops and removes the containers

  • make bash Connects to hotness container

  • make logs Shows all logs of all containers

Project files are bound to each other with host and container. Whenever you change any project file from the host or the container, the same change will happen on the opposite side as well.

After connecting to hotness container you can run the applicaton with:

$ fedora-messaging consume

Before you can run the-new-hotness, you need to add your bugzilla credentials to the configuration. You can set these credentials in ~/config.toml in the virtual machine.

You also need to acquire a valid Kerberos ticket to perform Koji scratch builds. You can get this by performing kinit <fas-username>@FEDORAPROJECT.ORG. When using two-factor authentication, please follow official fedora guide.

Warning

Services will fail to start if you do not provide valid credentials.

Simulating updates

You can now replay actual messages the production deployment of Anitya has sent with fedora-messaging-replay.py:

$ python3 devel/fedora-messaging-replay.py <msg-id>

There’s a helpful script to retrieve message IDs. From the root of the repository:

$ python devel/anitya_updates.py

Release notes

To add entries to the release notes, create a file in the news directory with the source.type name format, where the source part of the filename is:

  • 42 when the change is described in issue 42

  • PR42 when the change has been implemented in pull request 42, and there is no associated issue

  • username for contributors (author extention). It should be the username part of their commit’s email address.

And where type is label of the issue or PR that is named type.label. If the issue or PR is missing a label, please ask maintainer to add one.

News type can be one of the following:

  • feature: for new features

  • bug: for bug fixes

  • api: for API changes

  • dev: for development-related changes

  • author: for contributor names

  • other: for other changes

For example:

If this PR is solving issue #714 labeled as type.bug and named “Javascript error on add project page”, the file inside news should be called 714.bug (PR714.bug if the PR does not have any linked issue and the PR number is 714) and the content of the file would be:

Javascript error on add project page

Matching the issue title.

The text inside the file will be used as entry text. A preview of the release notes can be generated with towncrier --draft.

Release testing guide

Before releasing a new version it is good to try deployment in staging environment. To deploy the release candidate to staging follow these steps:

  1. Clone the-new-hotness repository:

    $ git clone git@github.com:fedora-infra/the-new-hotness.git
    
  2. Checkout the staging branch:

    $ git checkout staging
    
  3. Rebase the current staging branch to master:

    $ git rebase master
    
  4. Push the changes back to staging branch:

    $ git push origin staging
    

The new staging branch will be automatically deployed in the staging environment.

Note

This guide assumes that you have write permissions for the-new-hotness repository.

Release Guide

To do the release you need following python packages installed:

wheel
twine
towncrier

If you are a maintainer and wish to make a release, follow these steps:

  1. Change the version in hotness.__init__.__version__. This is used to set the version in the documentation project and the setup.py file.

  2. (Optional) Update version in hotness_schema/setup.py script.

  3. Get authors of commits by python get-authors.py.

Note

This script must be executed in news folder, because it creates files in current working directory.

  1. Generate the changelog by running towncrier.

Note

If you added any news fragment in the previous step, you might see towncrier complaining about removing them, because they are not committed in git. Just ignore this and remove all of them manually; release notes will be generated anyway.

  1. Remove every remaining news fragment from news folder.

  2. Commit your changes with message the-new-hotness <version>.

  3. Tag a release with git tag -s <version>.

  4. Don’t forget to git push --tags.

  5. Build the Python packages with python setup.py sdist bdist_wheel.

  6. Upload the packages with twine upload dist/<dists>.

  7. (Optional) Repeat steps 9 and 10 in hotness_schema folder.

  8. Create new release on GitHub releases.

  9. Deploy the new version in staging:

    $ git checkout staging
    $ git rebase master
    $ git push origin staging
    
  10. When successfully tested in staging deploy to production:

    $ git checkout production
    $ git rebase staging
    $ git push origin production
    

Note

Optional steps are required only if you want to release a new version of message schema.