Ansible module for git add/commit/push operations.
Project description
git-acp-ansible
git_acp
is an Ansible module for git add
, git commit
, git push
and git config
operations on local or remote (https/ssh) git repo.
PyPi Install:
To install the module just run the command:
pip install git-acp-ansible
Edit your ansible.cfg
file and add the path where git_acp
module is installed.
i.e.
[defaults]
library = ./lib/python3.7/site-packages/git-acp-ansible/modules
If you run a virtualenv
most probably the path would be something similar to the example above.
Otherwise you can use for example mlocate
to find where the module is.
For more info, have a look to Ansible Docs
Ansible Galaxy Install (for Ansible version > 2.9)
All info related to Ansible Galax install are available here
Module Documentation:
module: git_acp
options:
path:
description:
- Folder path where C(.git/) is located.
required: true
type: path
comment:
description:
- Git commit comment. Same as C(git commit -m).
type: str
required: true
add:
description:
- List of files under C(path) to be staged. Same as C(git add .).
File globs not accepted, such as C(./*) or C(*).
type: list
elements: str
default: ["."]
user:
description:
- Git username for https operations.
type: str
token:
description:
- Git API token for https operations.
type: str
branch:
description:
- Git branch where perform git push.
required: True
type: str
push_option:
description:
- Git push options. Same as C(git --push-option=option).
type: str
mode:
description:
- Git operations are performend eithr over ssh, https or local.
Same as C(git@git...) or C(https://user:token@git...).
choices: ['ssh', 'https', 'local']
default: ssh
type: str
url:
description:
- Git repo URL.
required: True
type: str
remote:
description:
- Local system alias for git remote PUSH and PULL repository operations.
type: str
default: origin
user_name:
description:
- Explicit git local user name. Nice to have for remote operations.
type: str
user_email:
description:
- Explicit git local email address. Nice to have for remote operations.
type: str
Examples:
- name: HTTPS | add file1.
git_acp:
user: Federico87
token: mytoken
path: /Users/git/git_acp
branch: master
comment: Add file1.
remote: origin
add: [ "." ]
mode: https
url: "https://gitlab.com/networkAutomation/git_test_module.git"
- name: SSH | add file1.
git_acp:
path: /Users/git/git_acp
branch: master
comment: Add file1.
add: [ file1 ]
remote: dev_test
mode: ssh
url: "git@gitlab.com:networkAutomation/git_test_module.git"
user_name: lvrfrc87
user_email: lvrfrc87@gmail.com
- name: LOCAL | push on local repo.
git_acp:
path: "~/test_directory/repo"
branch: master
comment: Add file1.
add: [ file1 ]
mode: local
url: /Users/federicoolivieri/test_directory/repo.git
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
git-acp-ansible-1.1.2.tar.gz
(6.2 kB
view hashes)
Built Distribution
Close
Hashes for git_acp_ansible-1.1.2-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 482c3fc96bc65be81349b9b3dcc386398e41b0c7d54dfbd3f43fcc501d82c091 |
|
MD5 | 8ca971d675316fa3e8ce2339730b429b |
|
BLAKE2b-256 | 11a5cb1c47c8b19936e2a4123e392d9ba5e788a60eab36441f899842ad461b63 |