vscodium

Ansible Role: vscodium

Ansible role that installs vscodium on Linux.

Beta Warning

This role is currently in beta and is not intended for production use. Breaking changes may occur between releases, so please make sure to read the release notes.

Requirements

This role depends on certain collections that are not included in ansible-core.

To install this role's requirements, create a requirements.yml file with the following contents:

# SPDX-FileCopyrightText: 2022 Maxwell G (@gotmax23)
# SPDX-License-Identifier: CC0-1.0
---
collections:
  - name: community.general

Then, if you are using ansible-base/ansible-core 2.10 or later, run this command.

ansible-galaxy install -r requirements.yml

If you are still using Ansible 2.9, run this command, instead.

ansible-galaxy collection install -r requirements.yml

Role Variables

Available Installation Methods

This role installs codium from upstream's apt/rpm repo where available. On Archlinux, it installs the code package from the distro's official repos.

Here are this role's variables and their default values, as set in defaults/main.yml. If you'd like, you may change them to customize this role's behavior.

# SPDX-FileCopyrightText: 2022 Maxwell G (@gotmax23)
# SPDX-License-Identifier: CC0-1.0
---
# Options:
# - `present` ensures that Vscodium is installed.
# - `absent` ensures that Vscodium is not installed.
vscodium_state: present

# apt/rpm repository mirror url.
# See https://gitlab.com/paulcarroty/vscodium-deb-rpm-repo#mirrors for a full list.
vscodium_mirror: https://paulcarroty.gitlab.io/vscodium-deb-rpm-repo

# Whether to check the apt/rpm repo signing key's fingerprint before importing it.
vscodium_check_key_fingerprint: true

Example Playbook

# SPDX-FileCopyrightText: 2022 Maxwell G (@gotmax23)
# SPDX-License-Identifier: CC0-1.0
---
- name: Install Vscodium
  hosts: all
  become: true

  tasks:
    - name: Update apt cache
      when: ansible_pkg_mgr == "apt"
      ansible.builtin.apt:
        update_cache: true
        cache_valid_time: 3600

    - name: Install Vscodium
      ansible.builtin.include_role:
        name: "gotmax23.vscodium"

Compatibility

This role is tested using the latest version of ansible-core and the latest version of the collections from Ansible Galaxy. This is the only version of Ansible that this role officially supports. Best effort support is provided for other versions.

This role is compatible with the following distros: