farmmanic / ansible-collection-workstation

ansible collection with roles for setting up my workstation

Ansible Collection - donhector.workstation

Ansible collection that includes the roles to setup my workstation.

This repo uses the following toolchain:

• pre-commit checks
• conventional commit messages enforcement via commitizen
• semantic release for automatic versioning
• github actions for CI and CD -- CI consists of collection testing via molecule. -- CD consists of releasing to Github and Ansible Galaxy

Developement

Setup

make install

Test

To test the entire collection including linting:

cd donhector/workstation
make test

To test individual roles:

cd donhector/workstation
make test-<role>

If you are only after linting, you can use the make lint target instead.

I personally recommend that you configure linting on file saving (ie use the official 'ansible' extension in VScode)

To run the role directly against your local host (vs testing it inside a molecule test container):

cd donhector/workstation/roles/<role>
make run

Releasing the collection

This repo is configured to automatically release a new version to Github and Galaxy whenever a new PR is merged into main (the very much preferred method)

Auto-merge is enabled so if the PR is green (passes all checks) is merged to main and therefore the CD workflow is triggered.

This might or might no result in a new release. That would depend on the semantic commits included in PR.

If you want to manually push a new release to Galaxy from your own machine (not recommended), you could still do so:

Build

cd donhector/workstation
NEW_VERSION='1.0.0-SNAPSHOT'
sed -i "s/^version:.*/version: ${NEW_VERSION}/g" galaxy.yml
make build

Publish

Set your Galaxy token in donhector/workstation/.env (See donhector/workstation/.env.sample for reference)

cd donhector/workstation
make publish

Install

If you want to install the collection from the tarball to inspect its contents:

cd donhector/workstation
make install

By default the collection will get installed at ~/.ansible/collections/ansible_collections/donhector/workstation