This repository has been archived by the owner on Jun 19, 2023. It is now read-only.
forked from arevak/role-asdf
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
66a2597
commit e9abefd
Showing
1 changed file
with
1 addition
and
114 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,117 +1,4 @@ | ||
| # role-asdf | ||
|
|
||
| ### Master: | ||
| [](https://github.com/osx-provisioner/role-asdf/actions/workflows/push.yml) | ||
| This project is now deprecated, it's functionality has been migrated to [osx-provisioner.collection](https://github.com/osx-provisioner/collection). | ||
|
|
||
| ### Production: | ||
| [](https://github.com/osx-provisioner/role-asdf/actions/workflows/push.yml) | ||
|
|
||
| Ansible role that installs the asdf version manager on OSX machines. | ||
|
|
||
| ### Notes: | ||
| - See the [asdf documentation](https://asdf-vm.com/) for further details about this tool. | ||
| - This role was inspired and derived from [this](https://github.com/cimon-io/ansible-role-asdf) fantastic Ansible role for Linux machines. | ||
|
|
||
| Requirements | ||
| ------------ | ||
|
|
||
| - [Homebrew](https://brew.sh/) must already be present on the machine ([geerlingguy.mac.homebrew](https://github.com/geerlingguy/ansible-collection-mac) is a great solution for this). | ||
|
|
||
|
|
||
| Role Variables | ||
| -------------- | ||
|
|
||
| ### Global Configuration | ||
|
|
||
| The following variables are globally configured: | ||
| - `asdf_version`: | ||
| - Sets the tag or branch of asdf to install. | ||
| - `asdf_user`: | ||
| - Sets a user for which the role is installed. This user needs to be able to run Homebrew to install the dependencies required for asdf plugins. | ||
| - For further details see the [geeringguy.mac.homebrew](https://github.com/geerlingguy/ansible-collection-mac) repository. (You may need to set the `homebrew_user` variable as well.) | ||
| - The default value will work fine if you're simply installing for the current user. | ||
| - `asdf_user_home`: | ||
| - Sets the user's home folder location, if needed. Take care to set it explicitly when installing for another user. | ||
| - `asdf_homebrew_retries`: | ||
| - Sets the number of attempts homebrew will make to install dependencies. (For flaky network connections.) | ||
| - `asdf_legacy_version_file`: | ||
| - Specifies if plugins which support this feature should read the version files used by other version managers (e.g. `.ruby-version` in the case of Ruby's rbenv). | ||
| - `asdf_darwin_global_dependencies`: | ||
| - Sets homebrew packages which will be installed with any asdf install. | ||
| - `asdf_darwin_optional_dependencies`: | ||
| - Sets additional requirements that will be installed with any asdf plugin install. | ||
|
|
||
| ### Global Package Manifest | ||
|
|
||
| Each plugin should be configured in the following dictionary: | ||
|
|
||
| ```yaml | ||
| asdf_plugins: | ||
| - name: "erlang" # a plugin name | ||
| environment: {} # an optional dictionary of environment variables for build configuration | ||
| pre_install: "" # an optional command to run directly before the installation (i.e. select a Python Interpreter for compilation) | ||
| repository: "" # a plugin repository, optional | ||
| versions: # a list of versions to install | ||
| - 23.3.3 | ||
| - 23.3.4 | ||
| delete_versions: [] # a list of existing versions that will be removed | ||
| global: 23.3.4 # set as a global version, optional | ||
| ``` | ||
| ### Plugin Specific Configuration | ||
| Plugins can also have their own specific dependencies and extra configuration. | ||
| To add extra dependencies, simply append your plugin to this list, and add the homebrew dependencies: | ||
| ```yaml | ||
| asdf_darwin_plugin_dependencies: | ||
| erlang: ["autoconf", "fop", "libyaml", "libxslt", "libtool", "unixodbc", "wxmac"] | ||
| nodejs: ["node-build"] | ||
| php: [] | ||
| ruby: [] | ||
| python: ["sqlite3", "xz", "zlib"] | ||
| ``` | ||
| To create additional custom configurations simply create a task file in the [plugin_tasks](./tasks/plugins_darwin/plugin_tasks) folder in the format: `(PLUGIN_NAME).yaml` | ||
| (i.e. `python.yml`, `nodejs.yml`) | ||
|
|
||
| ### Default Values | ||
|
|
||
| [See The Default Values](defaults/main.yml) | ||
|
|
||
| Dependencies | ||
| ------------ | ||
|
|
||
| None | ||
|
|
||
| Example Playbook | ||
| ---------------- | ||
|
|
||
| ```yaml | ||
| - hosts: all | ||
| roles: | ||
| - role: elliotweiser.osx-command-line-tools # Dependency of geerlingguy.mac.homebrew | ||
| - role: geerlingguy.mac.homebrew | ||
| - role: osx_provisioner.asdf | ||
| asdf_plugins: | ||
| - name: "erlang" | ||
| versions: ["23.3.4", "23.3.3"] | ||
| global: "23.3.4" | ||
| environment: | ||
| KERL_CONFIGURE_OPTIONS: "--without-javac --with-ssl=/usr/local/opt/[email protected] --disable-hipe" | ||
| CFLAGS: "-O2 -g -fno-stack-check" | ||
| - name: "python" | ||
| versions: "3.9.1" | ||
| ``` | ||
|
|
||
| License | ||
| ------- | ||
|
|
||
| MIT | ||
|
|
||
| (asdf is also licensed as MIT) | ||
|
|
||
| Author Information | ||
| ------------------ | ||
|
|
||
| Niall Byrne <[email protected]> |