Version information
released Dec 29th 2022
This version is compatible with:
- Puppet Enterprise 2023.2.x, 2023.1.x, 2023.0.x, 2021.7.x, 2021.6.x, 2021.5.x, 2021.4.x, 2021.3.x, 2021.2.x, 2021.1.x, 2021.0.x, 2019.8.x, 2019.7.x, 2019.5.x, 2019.4.x, 2019.3.x, 2019.2.x, 2019.1.x, 2019.0.x
- Puppet >= 6.0.0 < 8.0.0
- , , OracleLinux, Scientific, Fedora, Rocky, AlmaLinux, , , , , DragonFly, ArchLinux
Start using this module
Add this module to your Puppetfile:
mod 'rehan-ohmyzsh', '5.0.1'Learn more about managing modules with a PuppetfileDocumentation
rehan/ohmyzsh — version 5.0.1 Dec 29th 2022
rehan-ohmyzsh
Table of Contents
Overview
This is a oh-my-zsh module. It installs oh-my-zsh for a user and can change their shell to zsh. It can install and configure themes and plugins for users.
Module Description
oh-my-zsh is a community-driven framework for managing your zsh configuration. See https://github.com/robbyrussell/oh-my-zsh for more details.
Setup
In order to install rehan-ohmyzsh, run the following command:
$ puppet module install rehan-ohmyzsh
The module does expect all the data to be provided through 'Hiera'. See Usage for examples on how to configure it.
Requirements
This module is designed to be as clean and compliant with latest puppet code guidelines.
Usage
# for a single user
ohmyzsh::install { 'user1': }
# for multiple users in one shot and set their shell to zsh
ohmyzsh::install { ['root', 'user1']: set_sh => true }
# install and disable prompt for automatic updates
ohmyzsh::install { 'user2': auto_update_mode => disabled }
# install and sync the .zshrc when upstream project is updated.
ohmyzsh::install { 'user2': update_zshrc => sync }
# install a theme for a user
ohmyzsh::fetch::theme { 'root': url => 'http://zanloy.com/files/dotfiles/oh-my-zsh/squared.zsh-theme' }
# set a theme for a user
ohmyzsh::theme { ['root', 'user1']: } # would install 'clean' theme as default
ohmyzsh::theme { ['root', 'user1']: theme => 'robbyrussell' } # specific theme
# activate plugins for a user
ohmyzsh::plugins { 'user1': plugins => ['git', 'github'] }
YAML
ohmyzsh::installs:
alice:
set_sh: true
bob:
set_sh: true
ohmyzsh::themes:
alice:
theme: 'random'
bob:
theme: 'amuse'
ohmyzsh::plugins:
alice:
plugins: ['autojump', 'git', 'screen', 'ssh-agent', 'sudo', 'tmux' ]
custom_plugins:
zsh-syntax-highlighting:
ensure: latest
source: git
url: 'https://github.com/zsh-users/zsh-syntax-highlighting.git'
zsh-autosuggestions:
ensure: latest
source: git
url: 'https://github.com/zsh-users/zsh-autosuggestions.git'
bob:
plugins: ['autojump', 'git', 'screen', 'ssh-agent', 'sudo', 'tmux', 'vagrant', 'scala', 'rvm' ]
Dependencies
Development
You can submit pull requests and create issues through the official page of this module on GitHub. Please do report any bug and suggest new features/improvements.
Acknowledgments
This module was originally a fork of zanloy/ohmyzsh at version 0.1.3
5.0.1 (December 29, 2022)
Improvements:
- Add the package dependency for unmanaged users. (#39; Safranil)
- Streamline
installinter-dependencies to ensure all applicable tasks execute in correct order and nothing is missed out.
5.0.0 (December 16, 2022)
Breaking Changes:
This release addresses the upstream changes in oh-my-zsh related to DISABLE_AUTO_UPDATE
variable being deprecated. It replaces the disable_auto_update with auto_update_mode and auto_update_frequency variables in class ohmyzsh::install. The auto_update_mode has these values (auto, disabled, reminder). This is as per documentation for oh-my-zsh.
Also, this release replaces override_template feature with a new update_zshrc variable in ohmyzsh::install. This new variable has three values:
always- Always replaces your local .zshrc file with upstream template. Use it with care!disabled- Disables replacement of your local .zshrc file with upstream template except if the file does not exist or on first installation. This is default.sync- Replaces your local .zshrc file with upstream template only when there is a change in upstream git repository. The upstream change is not just limited to the template but could be any file.
There is a backup feature that creates a backup of your previous .zshrc file using the following naming convention:
.zshrc.bak.$(date +'%Y-%m-%dT%H:%M:%S%:z')
It is enabled by default but can be disabled using backup_zshrc variable.
4.1.0 (November 16, 2022)
Improvements:
- fix disable_auto_update. (#34; anthonysomerset)
- Add the ability to customize the clone for plugins. (#32; Safranil)
- Add the ability to use a Git repository for themes. (#32; Safranil)
- Updated os support matrix.
- Updated
pdktemplates.
4.0.0 (April 3, 2022)
Breaking Changes:
- Updated upstream ohmyzsh project url to reflect the new repository. (#28; anthonysomerset)
- Note: To get this module working again, please manually delete the directory
~/.oh-my-zshand then run the puppet again.
Improvements:
- Updated
pdktemplates. - Fix permissions on
~/.oh-my-zsh/cache/completions.
3.0.0 (December 23, 2021)
Improvements:
- Support for proper FreeBSD shell path. (#22; dctrotz)
- Updated os support matrix.
- Updated
pdktemplates. - Updated minimum
puppetversion to6.0.0. - Updated dependency versions.
2.4.0 (May 7, 2021)
Improvements:
- Updated os support matrix.
- Updated
pdktemplates. - Updated travis-ci links in the documentation.
- Added acceptance tests for openSUSE Leap 15.
2.3.2 (May 1, 2020)
Improvements:
- Added support for Ubuntu 20.04.
2.3.1 (April 12, 2020)
Improvements:
- Updated
pdktemplates.
2.3.0 (February 14, 2020)
Improvements:
- Added support for CentOS 8.
- Updated os support matrix.
- Updated
pdktemplates.
2.2.0 (August 25, 2019)
Improvements:
- Added support for Debian 10.
- Updated os support matrix.
- Updated
pdktemplates.
2.1.3 (June 15, 2019)
Improvements:
- Updated minimum
puppetversion to 5.5.10. - Updated os support matrix.
- Updated
pdktemplates.
2.1.2 (January 21, 2019)
Improvements:
- Change the default value for override_template from
truetofalse. This change is due to the upstream PR #7498.
2.1.1 (January 5, 2019)
Bugfixes:
- Fix the issue with multiple line replacement for plugins section in the zshrc template. #14
Improvements:
- Updated
pdktemplates.
2.1.0 (October 14, 2018)
Improvements:
- Updated
pdktemplates. - Added support for
puppetversion 6.
2.0.5 (September 1, 2018)
Improvements:
- Updated
pdktemplates. - Added tests for Ubuntu 18.04 release.
- Added tests for Debian 9 release.
- Updated
puppetlabs-stdlibdependency version.
2.0.4 (May 19, 2018)
Improvements:
- Updated documentation.
2.0.3 (May 9, 2018)
Improvements:
- Updated
pdktemplates. - Updated minimum required
puppetversion to4.10.0. - Improved acceptance tests.
2.0.2 (April 23, 2018)
Improvements:
- Updated module data to
hiera 5. - Improved acceptance tests.
2.0.1 (April 22, 2018)
Improvements:
- Updated documentation.
Bugfixes:
- Fixed the dependency cycle issues.
2.0.0 (April 22, 2018)
Features:
- Initial release
Dependencies
- puppetlabs-stdlib (>= 6.0.0 < 9.0.0)
- puppetlabs-vcsrepo (>= 3.0.0 < 6.0.0)
- rehan-wget (>= 1.0.0 < 3.0.0)
Apache License
Version 2.0, January 2004
http://www.apache.org/licenses/
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
1. Definitions.
"License" shall mean the terms and conditions for use, reproduction,
and distribution as defined by Sections 1 through 9 of this document.
"Licensor" shall mean the copyright owner or entity authorized by
the copyright owner that is granting the License.
"Legal Entity" shall mean the union of the acting entity and all
other entities that control, are controlled by, or are under common
control with that entity. For the purposes of this definition,
"control" means (i) the power, direct or indirect, to cause the
direction or management of such entity, whether by contract or
otherwise, or (ii) ownership of fifty percent (50%) or more of the
outstanding shares, or (iii) beneficial ownership of such entity.
"You" (or "Your") shall mean an individual or Legal Entity
exercising permissions granted by this License.
"Source" form shall mean the preferred form for making modifications,
including but not limited to software source code, documentation
source, and configuration files.
"Object" form shall mean any form resulting from mechanical
transformation or translation of a Source form, including but
not limited to compiled object code, generated documentation,
and conversions to other media types.
"Work" shall mean the work of authorship, whether in Source or
Object form, made available under the License, as indicated by a
copyright notice that is included in or attached to the work
(an example is provided in the Appendix below).
"Derivative Works" shall mean any work, whether in Source or Object
form, that is based on (or derived from) the Work and for which the
editorial revisions, annotations, elaborations, or other modifications
represent, as a whole, an original work of authorship. For the purposes
of this License, Derivative Works shall not include works that remain
separable from, or merely link (or bind by name) to the interfaces of,
the Work and Derivative Works thereof.
"Contribution" shall mean any work of authorship, including
the original version of the Work and any modifications or additions
to that Work or Derivative Works thereof, that is intentionally
submitted to Licensor for inclusion in the Work by the copyright owner
or by an individual or Legal Entity authorized to submit on behalf of
the copyright owner. For the purposes of this definition, "submitted"
means any form of electronic, verbal, or written communication sent
to the Licensor or its representatives, including but not limited to
communication on electronic mailing lists, source code control systems,
and issue tracking systems that are managed by, or on behalf of, the
Licensor for the purpose of discussing and improving the Work, but
excluding communication that is conspicuously marked or otherwise
designated in writing by the copyright owner as "Not a Contribution."
"Contributor" shall mean Licensor and any individual or Legal Entity
on behalf of whom a Contribution has been received by Licensor and
subsequently incorporated within the Work.
2. Grant of Copyright License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
copyright license to reproduce, prepare Derivative Works of,
publicly display, publicly perform, sublicense, and distribute the
Work and such Derivative Works in Source or Object form.
3. Grant of Patent License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
(except as stated in this section) patent license to make, have made,
use, offer to sell, sell, import, and otherwise transfer the Work,
where such license applies only to those patent claims licensable
by such Contributor that are necessarily infringed by their
Contribution(s) alone or by combination of their Contribution(s)
with the Work to which such Contribution(s) was submitted. If You
institute patent litigation against any entity (including a
cross-claim or counterclaim in a lawsuit) alleging that the Work
or a Contribution incorporated within the Work constitutes direct
or contributory patent infringement, then any patent licenses
granted to You under this License for that Work shall terminate
as of the date such litigation is filed.
4. Redistribution. You may reproduce and distribute copies of the
Work or Derivative Works thereof in any medium, with or without
modifications, and in Source or Object form, provided that You
meet the following conditions:
(a) You must give any other recipients of the Work or
Derivative Works a copy of this License; and
(b) You must cause any modified files to carry prominent notices
stating that You changed the files; and
(c) You must retain, in the Source form of any Derivative Works
that You distribute, all copyright, patent, trademark, and
attribution notices from the Source form of the Work,
excluding those notices that do not pertain to any part of
the Derivative Works; and
(d) If the Work includes a "NOTICE" text file as part of its
distribution, then any Derivative Works that You distribute must
include a readable copy of the attribution notices contained
within such NOTICE file, excluding those notices that do not
pertain to any part of the Derivative Works, in at least one
of the following places: within a NOTICE text file distributed
as part of the Derivative Works; within the Source form or
documentation, if provided along with the Derivative Works; or,
within a display generated by the Derivative Works, if and
wherever such third-party notices normally appear. The contents
of the NOTICE file are for informational purposes only and
do not modify the License. You may add Your own attribution
notices within Derivative Works that You distribute, alongside
or as an addendum to the NOTICE text from the Work, provided
that such additional attribution notices cannot be construed
as modifying the License.
You may add Your own copyright statement to Your modifications and
may provide additional or different license terms and conditions
for use, reproduction, or distribution of Your modifications, or
for any such Derivative Works as a whole, provided Your use,
reproduction, and distribution of the Work otherwise complies with
the conditions stated in this License.
5. Submission of Contributions. Unless You explicitly state otherwise,
any Contribution intentionally submitted for inclusion in the Work
by You to the Licensor shall be under the terms and conditions of
this License, without any additional terms or conditions.
Notwithstanding the above, nothing herein shall supersede or modify
the terms of any separate license agreement you may have executed
with Licensor regarding such Contributions.
6. Trademarks. This License does not grant permission to use the trade
names, trademarks, service marks, or product names of the Licensor,
except as required for reasonable and customary use in describing the
origin of the Work and reproducing the content of the NOTICE file.
7. Disclaimer of Warranty. Unless required by applicable law or
agreed to in writing, Licensor provides the Work (and each
Contributor provides its Contributions) on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
implied, including, without limitation, any warranties or conditions
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
PARTICULAR PURPOSE. You are solely responsible for determining the
appropriateness of using or redistributing the Work and assume any
risks associated with Your exercise of permissions under this License.
8. Limitation of Liability. In no event and under no legal theory,
whether in tort (including negligence), contract, or otherwise,
unless required by applicable law (such as deliberate and grossly
negligent acts) or agreed to in writing, shall any Contributor be
liable to You for damages, including any direct, indirect, special,
incidental, or consequential damages of any character arising as a
result of this License or out of the use or inability to use the
Work (including but not limited to damages for loss of goodwill,
work stoppage, computer failure or malfunction, or any and all
other commercial damages or losses), even if such Contributor
has been advised of the possibility of such damages.
9. Accepting Warranty or Additional Liability. While redistributing
the Work or Derivative Works thereof, You may choose to offer,
and charge a fee for, acceptance of support, warranty, indemnity,
or other liability obligations and/or rights consistent with this
License. However, in accepting such obligations, You may act only
on Your own behalf and on Your sole responsibility, not on behalf
of any other Contributor, and only if You agree to indemnify,
defend, and hold each Contributor harmless for any liability
incurred by, or claims asserted against, such Contributor by reason
of your accepting any such warranty or additional liability.
END OF TERMS AND CONDITIONS
APPENDIX: How to apply the Apache License to your work.
To apply the Apache License to your work, attach the following
boilerplate notice, with the fields enclosed by brackets "[]"
replaced with your own identifying information. (Don't include
the brackets!) The text should be enclosed in the appropriate
comment syntax for the file format. We also recommend that a
file or class name and description of purpose be included on the
same "printed page" as the copyright notice for easier
identification within third-party archives.
Copyright [yyyy] [name of copyright owner]
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.