thisdwhitley.ansible_role_vscode
Ansible Role: vscode
This role will install and potentially configure the open source Visual Studio Code editor. Currently supported distributions (per requirements):
- Red Hat/CentOS 7+
- Fedora 27+
- Ubuntu 18.04+
I prefer to pass the variables "into" the role from the playbook versus by including variable files. This is because I hope to make the role usable by other projects/roles. I don't know if this logic makes sense or not, but I am essentially attempting to remove the variables from the role itself.
As of 2019-04-26 I am installing this via flatpak so this is a pretty large overhaul.
Important Notes
- This role started totally differently. But in using
coderegularly, I have found that updates come often and that it is not worth updating the role for each new version. - I am reverting back to using
moleculefor testing this role
Requirements
Any package requirements (generally for extensions) will be addressed in the role.
Role Variables
All of these variables should be considered optional however, be aware that sanity checking is minimal (if at all):
usersideally you could configure Visual Studio Code differently per user, and this nested list of users allows for thatusername- this is the username NOTE: this role will not create the user!
vscode_extensions- this is a list of extensions to install see example playbook
vscode_settings- this is a dictionary of settings applied via a template
Example Playbook
Playbook with configuration options specified:
- hosts: localhost
connection: local
roles:
- role: vscode
users:
- username: test_user1
vscode_extensions:
- vscoss.vscode-ansible
- stayfool.vscode-asciidoc
- dbankier.vscode-instant-markdown
- wholroyd.jinja
- DavidAnson.vscode-markdownlint
- ms-python.python
- AndrsDC.base16-themes
vscode_settings: {
"editor.rulers": [80, 100, 120],
"editor.renderWhitespace": true,
"files.associations": {
"Vagrantfile": "ruby"
}
}
Inclusion
I envision this role being included in a larger project through the use of a
requirements.yml file. So here is an example of what you would need in your
file:
# get the vscode role from github
- src: https://github.com/thisdwhitley/ansible-role-vscode.git
scm: git
name: vscode
Have the above in a requirements.yml file for your project would then allow
you to "install" it (prior to use in some sort of setup script?) with:
ansible-galaxy install -p ./roles -r requirements.yml
Testing
I am relying heavily on the work by Jeff Geerling in using Travis CI for testing
this role. I have, however, modified both tests/test.yml and .travis.yml in
order to include testing of the installation of extensions as well as config
changes. Please review those files, but here is a list of OSes currently being
tested (using geerlingguy's container images):
- centos7
- fedora27
- fedora28
- fedora29
- ubuntu18
Reference: How I test Ansible configuration on 7 different OSes with Docker
To-do
N/A
References
- GantSign's role
- Running VS Code on Linux
- How I test Ansible configuration on 7 different OSes with Docker
License
All parts of this project are made available under the terms of the MIT License.
ansible-galaxy install thisdwhitley.ansible_role_vscode