Back to the main page

AGENTS.md for Ansible project in Codex

C:\Users\zdudic\Documents\ChatGPT\Ansible\AGENTS.md

I have Codex installed in Windows Pro 11 system, this is general agent for Ansible project: file C:\Users\zdudic\Documents\ChatGPT\Ansible\AGENTS.md

# Ansible

This workspace is used to work with Ansible.

## Remote work

- From Zarko's Windows laptop, go to Linux host some-trusted-host.domain.com
- Ansible Git workspaces are under: `/home/zdudic/Git-Work/`
- Zarko will say if we need to work in another location.
- Work only in the repository and branch requested by Zarko. 
- Never work in master or main branch. If work branch is missing ask Zarko to create it first.

## Ansible conventions

- Start new YAML files with `---` and finish them with `...`.
- Follow the existing repository structure and naming conventions.
- Use the `.yml` extension for YAML files. 

## Supported Ansible version

- Validate current changes with ansible-core 2.15 and 2.22
- Version 2.15 is here: /some-path-2.15/ansible
- Version 2.22 is here: /some-path-2.22/ansible
- In these folders you also have ansible-galaxy and ansible-lint programs. 

## Line endings

- Preserve each file's existing line endings.
- Do not convert CRLF to LF or LF to CRLF.
- If a diff is caused only by line-ending conversion, restore the original line endings.

## Linting

After changing Ansible files, run ansible-lint.

- Version 2.15: /some-path-2.15/ansible-lint
- Version 2.22: /some-path-2.22/ansible-lint
- The lint for 2.15 must pass, if lint for 2.22 fails, talk to Zarko. 
- We can ignore some lint messages, talk to Zarko how to proceed. 

## Testing

- Zarko performs playbook and role testing.
- Codex may run syntax checks but must not run check-mode or live playbooks unless Zarko explicitly asks.

## Git staging

Zarko will do Git staging and push branch to remote and merge. You cannot do this.

You can only perform the following work: 

- git status
- git diff
- git diff --check
- file edits
- lint commands
- syntax checks
- check-mode tests
- Do not create or switch branches

You cannot run these commands:

- git add
- git commit
- git push
- git reset
- git checkout -- 

## Secrets

Never record passwords, private keys, tokens, or vault secrets in project
instructions, skills, inventories, playbooks, logs, or chat summaries.
Back to the main page