Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/huyz/ansible-collection-huyz-general
Ansible collection for general-purpose roles
https://github.com/huyz/ansible-collection-huyz-general
Last synced: about 1 month ago
JSON representation
Ansible collection for general-purpose roles
- Host: GitHub
- URL: https://github.com/huyz/ansible-collection-huyz-general
- Owner: huyz
- License: mit
- Created: 2023-02-23T18:00:24.000Z (almost 2 years ago)
- Default Branch: master
- Last Pushed: 2024-08-09T16:45:13.000Z (5 months ago)
- Last Synced: 2024-08-09T18:27:11.939Z (5 months ago)
- Language: Makefile
- Size: 478 KB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.rst
- License: LICENSE
Awesome Lists containing this project
README
# Ansible Collection: huyz.general
[![MIT licensed][badge-license]][link-license]
[![Galaxy Collection][badge-collection]][link-galaxy]
[![CI][badge-gh-actions]][link-gh-actions]
This Ansible collection contains roles for general use.
## Usage
Roles:
- `huyz.general.add_to_config_file` ([README](https://github.com/huyz/ansible-collection-huyz-general/blob/master/roles/add_to_config_file/README.md))
- Function: Safely insert a block into one or more shell config files.
- Use case: Mainly intended to be re-used by other roles.
- `huyz.general.prompt_password` ([README](https://github.com/huyz/ansible-collection-huyz-general/blob/master/roles/prompt_password/README.md))
- Function: Prompts for the `ansible_password` if not defined.
- Use case: Avoid the need to call `ansible-playbook` with `--ask-pass` and `--ask-become-pass`.
- `huyz.general.sudo_by_ssh_agent` ([README](https://github.com/huyz/ansible-collection-huyz-general/blob/master/roles/sudo_by_ssh_agent/README.md))
- Function: Configures sudo to use the `libpam-ssh-agent-auth` package and
authorize the provided ssh key.
- Use case: Avoid the need to authenticate with a password to run privileged commands.
---
## Development (of this repo)
1. Set `ANSIBLE_GALAXY_API_KEY` in `.env`
1. Run
```shell
direnv allow
```
### How to update the Changelog
#### First time setup
One time, to initialize:
```shell
antsibull-changelog init .
```
Update the `title` and set `keep_fragments: true`.
#### After each change
First, create a manual fragments in `changeslogs/fragments`.
Then, to lint the fragments:
```shell
antsibull-changelog lint
```
#### To test out in dot-super/general
```shell
make build
```
In `dot-super/general`, have `requirements.yml` contain:
```yaml
collections:
# my own collection (the development version)
- name: ../../ansible-collection-huyz-general/huyz-general-latest.tar.gz
```
```shell
# Add -f to force the update
install.sh
```
#### For a new release
First, create a manual fragment in `changeslogs/fragments` named `DATE_vVERSION_summary.yml` with `release_summary` property.
Then, generate the changelog for the release:
```shell
antsibull-changelog release --refresh-fragments --update-existing
```
### How to lint
First, stage your changes, then:
```shell
pre-commit run -v
```
### Overview of GitHub Actions
- `lint.yml`
- Triggered by: push to master and pull requests; weekly
- Runs pre-commit
- `ansible-molecule.yml`
- Triggered by: push to master and pull requests; weekly
- Runs Ansible Molecule on all the roles defined by the collection
- `publish.yml`
- Triggered by new tags
- Builds collection and publishes it to Ansible Galaxy
### How to publish on Ansible Galaxy
Typically:
1. Draft a new "GitHub release":
1. Choose tag: create new tag of the form `vX.Y.Z`.
1. Title: `vX.Y.Z`
1. Description: paste in the entry from the auto-generated `CHANGELOG.rst`
1. Check `Set as a pre-release`
1. The `publish.yml` GitHub Workflow should automatically publish a "Galaxy release".
1. Check the action results. If successful, edit the GitHub release:
1. Uncheck `Set as a pre-release`
1. Check `Set as the latest release`
Note that the "Publish on Galaxy" action can be triggered manually on github.com
To manually trigger a "Galaxy release" at the command line:
```shell
make publish
```
---
## License
MIT
[badge-license]: https://img.shields.io/github/license/huyz/ansible-collection-huyz-general
[link-license]: https://github.com/huyz/ansible-collection-huyz-general/blob/master/LICENSE
[badge-collection]: https://img.shields.io/badge/collection-huyz.general-blue
[link-galaxy]: https://galaxy.ansible.com/ui/repo/published/huyz/general/
[badge-gh-actions]: https://github.com/huyz/ansible-collection-huyz-general/actions/workflows/ansible-molecule.yml/badge.svg?event=push
[link-gh-actions]: https://github.com/huyz/ansible-collection-huyz-general/actions/workflows/ansible-molecule.yml