ansible / zuul-config

Global configuration for Software Factory Zuul instance

zuul-config

This repo contains the configuration of the Ansible Content CI https://ansible.softwarefactory-project.io/zuul/status.

Zuul

This directory contains the list of projects that are enabled. Edit these files to add, remove or rename a project in Zuul.

On-board new repo into Zuul

To add new repos into Zuul, it's a two step process:

Enable the Github Application

First, you MUST enable the softwarefactory-project-zuul https://github.com/apps/softwarefactory-project-zuul/ application in your Github project. If the project is in the ansible-collections/ https://github.com/ansible-collections namespace, you don't have to do anything.

PR1

• Add to resources/ansible.yaml

note: Follow up to the merge of the PR, Zuul will refresh its configuration. The job is called update-config. For various reason, the update may fail, you can take a look at the previous runs here: https://ansible.softwarefactory-project.io/zuul/builds?job_name=config-update&project=ansible/zuul-config

PR2

• Add to zuul.d/projects.yaml

note: You don't need to do it if the project satisfies the rules specified in the file. For example, rule 1 and rule 2 say that if a collection's repository name starts with ansible-collections/community* or sap-linux/community* and the repository has the main branch as default, the repository will be included in the project and published by Zuul on Galaxy automatically when a git tag is created in the collection's repo. In this case, only PR1 above is required.

note: In case you have a community.* collection in the github.com/ansible-collections/ organization, you need to add your collection to the explicit regular expression that enables the publish-to-galaxy-3pci template if you do not have an equivalent of the Galaxy importer test running in GHA.

Gating

If you want to let Zuul merge the new PRs you need to add a label called mergeit to your project. The branch also need to be protected, like this example:

Status

CI Dashboard

Talk to us

Matrix Chat Room https://matrix.to/#/#zuul:ansible.com

zuul-config's Issues

document migration from travis to zuul

Used to track things we need to document regarding migration to Zuul

• getting rid of noop job
• github project configuration with screenshots

ansible-zuul bot comments are not markdown friendly

Current comments from zuul made on github are not adding markdown backticks to mark code blocks, making much harder to read, especially when it comes to whitespace display.

Example: ansible-community/pytest-molecule#58

Zuul Job release-ansible-collection-galaxy failing for new Ansible Galaxy

Zuul Job release-ansible-collection-galaxy failing for new Ansible Galaxy

Upon new release created for Ansible Collection, the Zuul Job release-ansible-collection-galaxy has an issue with the latest Ansible Galaxy website release pushed live this weekend.

Task Summary
controller:

❌ Task  Publish collection to Ansible Galaxy / Automation Hub  failed running on host  controller

/home/zuul/src/github.com/ansible-network/releases/.tox/generate_collection_version/bin/ansible-galaxy -vvv collection publish /home/zuul/artifacts/xxxx.tar.gz

non-zero return code

ERROR! Error when finding available api versions from release_galaxy (https://galaxy.ansible.com/) (HTTP Code: 403, Message: Forbidden)

README: update at least "Enable GH App section"

https://github.com/ansible/zuul-config#enable-the-github-application
I think README came from old repo and it should be updated as I don't see tenants.yaml there.

Could anyone please update README not to be disturbed with asking for clarifications each time?

github-workflow job is too aggresive

While we know that gerrit would not be able to merge canges made to .github/workflows folders their existence should not be a reason block a job that does not touch these files.

With molecule projects we have important github specific integrations what are using workflows and migrating them could prove a real challend, still these integrations are not related to project code itself.

Example:

• https://github.com/pycontribs/pytest-molecule/blob/master/.github/workflows/release-drafter.yml which updates github release notes based on github data

• https://github.com/pycontribs/pytest-molecule/blob/master/.github/workflows/labels.yml which configures labels used

At least for start this job should fail only if current change is touching these files instead of failing if these files exist.

While we can live without the label automator, the release-note updater became a critical part of the development process as it removed the need to update https://github.com/pycontribs/pytest-molecule/releases ourselves (or to include these notes in CR)

Link to https://github.com/ansible/project-config

Can we please link there on the main page? It's so hard to get there from here

document release to pypi

Assuming you already have a tox -e upload job does this when these variables are defined TWINE_PASSWORD and TWINE_USERNAME.

• Where should we encrypt credentials?
• Do we have an already configured zuul pypi service account we can use?