gotmax23 / ansible-collection-sourcehut

Ansible collection for interacting with sourcehut API

gotmax23.sourcehut

This Ansible collection provides modules and plugins to interact with the sourcehut API.

Code of Conduct

We follow the Ansible Code of Conduct in all our interactions within this project.

If you encounter abusive behavior, please refer to the policy violations section of the Code for information on how to raise a complaint.

Communication

We announce important development changes and releases through Ansible's The Bullhorn newsletter. If you are a collection developer, be sure you are subscribed.

Join us on:

• The Ansible forum:
  • News & Announcements
  • Get Help
  • Social Spaces
• Matrix chat rooms:
  • #users:ansible.com: general use questions and support
  • #community:ansible.com: community and collection development questions
  • #social:ansible.com: to say "Good morning, community!"

For more information about communication, refer to the Ansible communication guide.

Contributing to this collection

The content of this collection is made by people like you, a community of individuals collaborating on making the world better through developing automation software.

We are actively accepting new contributors and all types of contributions are very welcome.

Don't know how to start? Refer to the Ansible community guide!

Want to submit code changes? Take a look at the Quick-start development guide.

We also use the following guidelines:

• Collection review checklist
• Ansible development guide
• Ansible collection development guide

Collection maintenance

The current maintainers are listed in the MAINTAINERS.md file. If you have questions or need help, feel free to mention them in the proposals.

To learn how to maintain/become a maintainer of this collection, refer to the Maintainer guidelines.

It is necessary for maintainers of this collection to be subscribed to:

• The collection itself (the Watch button -> All Activity in the upper right corner of the repository's homepage).
• The news-for-maintainers repository.

They also should be subscribed to Ansible's The Bullhorn newsletter.

Governance

The process of decision making in this collection is based on discussing and finding consensus among participants.

Every voice is important. If you have something on your mind, create an issue or dedicated discussion and let's discuss it!

Tested with Python

These modules are meant to be run from the Ansible controller and are only tested on the controller Python versions. See the next section for the supported Python and ansible-core versions.

Tested with ansible-core

• 2.14 (Python 3.9, 3.10, 3.11)
• 2.15 (Python 3.9, 3.10, 3.11)
• 2.16 (Python 3.10, 3.11, 3.12)

External requirements

• The sourcehutx Python library

Included content

TODO

Using this collection

TODO

Installing the Collection from Ansible Galaxy

Before using this collection, you need to install it with the Ansible Galaxy command-line tool:

ansible-galaxy collection install gotmax23.sourcehut

You can also include it in a requirements.yml file and install it with ansible-galaxy collection install -r requirements.yml, using the format:

---
collections:
  - name: gotmax23.sourcehut

Note that if you install the collection from Ansible Galaxy, it will not be upgraded automatically when you upgrade the ansible package. To upgrade the collection to the latest available version, run the following command:

ansible-galaxy collection install gotmax23.sourcehut --upgrade

You can also install a specific version of the collection, for example, if you need to downgrade when something is broken in the latest version (please report an issue in this repository). Use the following syntax to install version 0.1.0:

ansible-galaxy collection install gotmax23.sourcehut:==0.1.0

See using Ansible collections for more details.

Release notes

See the changelog.

More information

• Ansible user guide
• Ansible developer guide
• Ansible collections requirements
• Ansible community Code of Conduct
• The Bullhorn (the Ansible contributor newsletter)
• Important announcements for maintainers

Licensing

GNU General Public License v3.0 or later.

See LICENSES/GPL-3.0-or-later.txt to see the full text.