├── documentation └── .gitkeep ├── .mdlrc ├── .envrc ├── .gitattributes ├── .github ├── CODEOWNERS ├── lock.yml └── workflows │ ├── conventional-commits.yml │ ├── prevent-file-change.yml │ ├── release.yml │ ├── copilot-setup-steps.yml │ ├── stale.yml │ └── ci.yml ├── .release-please-manifest.json ├── Berksfile ├── CODE_OF_CONDUCT.md ├── kitchen.exec.yml ├── test └── integration │ └── source │ └── vim_spec.rb ├── TESTING.md ├── .vscode └── extensions.json ├── CONTRIBUTING.md ├── .markdownlint-cli2.yaml ├── spec ├── spec_helper.rb ├── default_spec.rb ├── package_spec.rb └── source_spec.rb ├── .yamllint ├── recipes ├── source_rhel.rb ├── default.rb ├── package.rb └── source.rb ├── release-please-config.json ├── .editorconfig ├── renovate.json ├── .overcommit.yml ├── metadata.rb ├── .gitignore ├── attributes ├── default.rb └── source.rb ├── kitchen.yml ├── kitchen.global.yml ├── Dangerfile ├── chefignore ├── README.md ├── kitchen.dokken.yml ├── CHANGELOG.md └── LICENSE /documentation/.gitkeep: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /.mdlrc: -------------------------------------------------------------------------------- 1 | rules "~MD013" 2 | -------------------------------------------------------------------------------- /.envrc: -------------------------------------------------------------------------------- 1 | use chefworkstation 2 | -------------------------------------------------------------------------------- /.gitattributes: -------------------------------------------------------------------------------- 1 | * text=auto eol=lf 2 | -------------------------------------------------------------------------------- /.github/CODEOWNERS: -------------------------------------------------------------------------------- 1 | * @sous-chefs/maintainers 2 | -------------------------------------------------------------------------------- /.release-please-manifest.json: -------------------------------------------------------------------------------- 1 | { 2 | ".": "3.0.3" 3 | } 4 | -------------------------------------------------------------------------------- /Berksfile: -------------------------------------------------------------------------------- 1 | source 'https://supermarket.chef.io' 2 | 3 | metadata 4 | 5 | group :integration do 6 | cookbook 'apt' 7 | cookbook 'homebrew' 8 | end 9 | -------------------------------------------------------------------------------- /CODE_OF_CONDUCT.md: -------------------------------------------------------------------------------- 1 | # Community Guidelines 2 | 3 | This project follows the Chef Community Guidelines 4 | -------------------------------------------------------------------------------- /kitchen.exec.yml: -------------------------------------------------------------------------------- 1 | --- 2 | driver: { name: exec } 3 | transport: { name: exec } 4 | 5 | platforms: 6 | - name: macos-latest 7 | - name: windows-latest 8 | -------------------------------------------------------------------------------- /test/integration/source/vim_spec.rb: -------------------------------------------------------------------------------- 1 | describe command('/usr/local/bin/vim --version') do 2 | it 'runs without error' do 3 | expect(subject.exit_status).to eq 0 4 | end 5 | end 6 | -------------------------------------------------------------------------------- /TESTING.md: -------------------------------------------------------------------------------- 1 | # Testing 2 | 3 | Please refer to [the community cookbook documentation on testing](https://github.com/chef-cookbooks/community_cookbook_documentation/blob/master/TESTING.MD). 4 | -------------------------------------------------------------------------------- /.vscode/extensions.json: -------------------------------------------------------------------------------- 1 | { 2 | "recommendations": [ 3 | "chef-software.chef", 4 | "rebornix.ruby", 5 | "editorconfig.editorconfig", 6 | "DavidAnson.vscode-markdownlint" 7 | ] 8 | } 9 | -------------------------------------------------------------------------------- /CONTRIBUTING.md: -------------------------------------------------------------------------------- 1 | # Contributing 2 | 3 | Please refer to 4 | [https://github.com/chef-cookbooks/community_cookbook_documentation/blob/master/CONTRIBUTING.MD](https://github.com/chef-cookbooks/community_cookbook_documentation/blob/master/CONTRIBUTING.MD) 5 | -------------------------------------------------------------------------------- /.github/lock.yml: -------------------------------------------------------------------------------- 1 | --- 2 | daysUntilLock: 365 3 | exemptLabels: [] 4 | lockLabel: false 5 | lockComment: > 6 | This thread has been automatically locked since there has not been 7 | any recent activity after it was closed. Please open a new issue for 8 | related bugs. 9 | -------------------------------------------------------------------------------- /.markdownlint-cli2.yaml: -------------------------------------------------------------------------------- 1 | config: 2 | ul-indent: false # MD007 3 | line-length: false # MD013 4 | no-duplicate-heading: false # MD024 5 | reference-links-images: false # MD052 6 | no-multiple-blanks: 7 | maximum: 2 8 | ignores: 9 | - .github/copilot-instructions.md 10 | -------------------------------------------------------------------------------- /spec/spec_helper.rb: -------------------------------------------------------------------------------- 1 | require 'chefspec' 2 | require 'chefspec/berkshelf' 3 | 4 | RSpec.configure do |config| 5 | config.color = true # Use color in STDOUT 6 | config.formatter = :documentation # Use the specified formatter 7 | config.log_level = :error # Avoid deprecation notice SPAM 8 | end 9 | -------------------------------------------------------------------------------- /.github/workflows/conventional-commits.yml: -------------------------------------------------------------------------------- 1 | --- 2 | name: conventional-commits 3 | 4 | "on": 5 | pull_request: 6 | types: 7 | - opened 8 | - reopened 9 | - edited 10 | - synchronize 11 | 12 | jobs: 13 | conventional-commits: 14 | uses: sous-chefs/.github/.github/workflows/conventional-commits.yml@5.0.3 15 | -------------------------------------------------------------------------------- /.yamllint: -------------------------------------------------------------------------------- 1 | --- 2 | extends: default 3 | rules: 4 | line-length: 5 | max: 256 6 | level: warning 7 | document-start: disable 8 | braces: 9 | forbid: false 10 | min-spaces-inside: 0 11 | max-spaces-inside: 1 12 | min-spaces-inside-empty: -1 13 | max-spaces-inside-empty: -1 14 | comments: 15 | min-spaces-from-content: 1 16 | -------------------------------------------------------------------------------- /recipes/source_rhel.rb: -------------------------------------------------------------------------------- 1 | # vim looks for xsubpp in wrong location RHEL 7+ and Fedora 2 | 3 | link '/usr/share/perl5/ExtUtils/xsubpp' do 4 | to '/usr/bin/xsubpp' 5 | only_if { ::File.exist?('/usr/bin/xsubpp') } # if package node attributes don't include perl this won't be here 6 | end if node['platform_version'].to_i >= 7 7 | 8 | package 'bzip2' if node['platform_version'].to_i >= 7 9 | -------------------------------------------------------------------------------- /release-please-config.json: -------------------------------------------------------------------------------- 1 | { 2 | "packages": { 3 | ".": { 4 | "package-name": "vim", 5 | "changelog-path": "CHANGELOG.md", 6 | "release-type": "ruby", 7 | "include-component-in-tag": false, 8 | "version-file": "metadata.rb" 9 | } 10 | }, 11 | "$schema": "https://raw.githubusercontent.com/googleapis/release-please/main/schemas/config.json" 12 | } 13 | -------------------------------------------------------------------------------- /.github/workflows/prevent-file-change.yml: -------------------------------------------------------------------------------- 1 | --- 2 | name: prevent-file-change 3 | 4 | "on": 5 | pull_request: 6 | types: 7 | - opened 8 | - reopened 9 | - edited 10 | - synchronize 11 | 12 | jobs: 13 | prevent-file-change: 14 | uses: sous-chefs/.github/.github/workflows/prevent-file-change.yml@5.0.3 15 | secrets: 16 | token: ${{ secrets.GITHUB_TOKEN }} 17 | -------------------------------------------------------------------------------- /.editorconfig: -------------------------------------------------------------------------------- 1 | # https://EditorConfig.org 2 | 3 | # top-most EditorConfig file 4 | root=true 5 | 6 | # Unix-style newlines with a newline ending every file 7 | [*] 8 | end_of_line = lf 9 | insert_final_newline = true 10 | 11 | # 2 space indentation 12 | indent_style = space 13 | indent_size = 2 14 | 15 | # Avoid issues parsing cookbook files later 16 | charset = utf-8 17 | 18 | # Avoid cookstyle warnings 19 | trim_trailing_whitespace = true 20 | -------------------------------------------------------------------------------- /spec/default_spec.rb: -------------------------------------------------------------------------------- 1 | require 'spec_helper' 2 | 3 | describe 'vim::default' do 4 | platform 'ubuntu' 5 | 6 | it 'should include the vim::package recipe when install_method = "package"' do 7 | is_expected.to include_recipe('vim::package') 8 | end 9 | 10 | context 'when install_method = "source"' do 11 | override_attributes['vim']['install_method'] = 'source' 12 | 13 | it 'should include the vim::source recipe' do 14 | is_expected.to include_recipe('vim::source') 15 | end 16 | end 17 | end 18 | -------------------------------------------------------------------------------- /renovate.json: -------------------------------------------------------------------------------- 1 | { 2 | "$schema": "https://docs.renovatebot.com/renovate-schema.json", 3 | "extends": ["config:base"], 4 | "packageRules": [ 5 | { 6 | "groupName": "Actions", 7 | "matchUpdateTypes": ["minor", "patch", "pin"], 8 | "automerge": true, 9 | "addLabels": ["Release: Patch", "Skip: Announcements"] 10 | }, 11 | { 12 | "groupName": "Actions", 13 | "matchUpdateTypes": ["major"], 14 | "automerge": false, 15 | "addLabels": ["Release: Patch", "Skip: Announcements"] 16 | } 17 | ] 18 | } 19 | -------------------------------------------------------------------------------- /.github/workflows/release.yml: -------------------------------------------------------------------------------- 1 | --- 2 | name: release 3 | 4 | "on": 5 | push: 6 | branches: 7 | - main 8 | 9 | permissions: 10 | contents: write 11 | issues: write 12 | pull-requests: write 13 | packages: write 14 | attestations: write 15 | id-token: write 16 | 17 | jobs: 18 | release: 19 | uses: sous-chefs/.github/.github/workflows/release-cookbook.yml@5.0.3 20 | secrets: 21 | token: ${{ secrets.PORTER_GITHUB_TOKEN }} 22 | supermarket_user: ${{ secrets.CHEF_SUPERMARKET_USER }} 23 | supermarket_key: ${{ secrets.CHEF_SUPERMARKET_KEY }} 24 | -------------------------------------------------------------------------------- /.overcommit.yml: -------------------------------------------------------------------------------- 1 | --- 2 | PreCommit: 3 | TrailingWhitespace: 4 | enabled: true 5 | YamlLint: 6 | enabled: true 7 | required_executable: "yamllint" 8 | ChefSpec: 9 | enabled: true 10 | required_executable: "chef" 11 | command: ["chef", "exec", "rspec"] 12 | Cookstyle: 13 | enabled: true 14 | required_executable: "cookstyle" 15 | command: ["cookstyle"] 16 | MarkdownLint: 17 | enabled: false 18 | required_executable: "npx" 19 | command: ["npx", "markdownlint-cli2", "'**/*.md'"] 20 | include: ["**/*.md"] 21 | 22 | CommitMsg: 23 | HardTabs: 24 | enabled: true 25 | -------------------------------------------------------------------------------- /.github/workflows/copilot-setup-steps.yml: -------------------------------------------------------------------------------- 1 | --- 2 | name: 'Copilot Setup Steps' 3 | 4 | "on": 5 | workflow_dispatch: 6 | push: 7 | paths: 8 | - .github/workflows/copilot-setup-steps.yml 9 | pull_request: 10 | paths: 11 | - .github/workflows/copilot-setup-steps.yml 12 | 13 | jobs: 14 | copilot-setup-steps: 15 | runs-on: ubuntu-latest 16 | permissions: 17 | contents: read 18 | steps: 19 | - name: Check out code 20 | uses: actions/checkout@v5 21 | - name: Install Chef 22 | uses: actionshub/chef-install@main 23 | - name: Install cookbooks 24 | run: berks install 25 | -------------------------------------------------------------------------------- /metadata.rb: -------------------------------------------------------------------------------- 1 | name 'vim' 2 | maintainer 'Sous Chefs' 3 | maintainer_email 'help@sous-chefs.org' 4 | license 'Apache-2.0' 5 | description 'Installs vim and optional extra packages.' 6 | source_url 'https://github.com/chef-cookbooks/vim' 7 | issues_url 'https://github.com/chef-cookbooks/vim/issues' 8 | chef_version '>= 15.3' 9 | 10 | version '3.0.3' 11 | 12 | supports 'debian' 13 | supports 'ubuntu' 14 | supports 'redhat' 15 | supports 'centos' 16 | supports 'fedora' 17 | supports 'scientific' 18 | supports 'oracle' 19 | supports 'amazon' 20 | supports 'zlinux' 21 | supports 'suse' 22 | supports 'opensuse' 23 | supports 'opensuseleap' 24 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | *.rbc 2 | .config 3 | InstalledFiles 4 | pkg 5 | test/tmp 6 | test/version_tmp 7 | tmp 8 | _Store 9 | *~ 10 | *# 11 | .#* 12 | \#*# 13 | *.un~ 14 | *.tmp 15 | *.bk 16 | *.bkup 17 | 18 | # editor files 19 | .idea 20 | .*.sw[a-z] 21 | 22 | # ruby/bundler/rspec files 23 | .ruby-version 24 | .ruby-gemset 25 | .rvmrc 26 | Gemfile.lock 27 | .bundle 28 | *.gem 29 | coverage 30 | spec/reports 31 | 32 | # YARD / rdoc artifacts 33 | .yardoc 34 | _yardoc 35 | doc/ 36 | rdoc 37 | 38 | # chef infra stuff 39 | Berksfile.lock 40 | .kitchen 41 | kitchen.local.yml 42 | vendor/ 43 | .coverage/ 44 | .zero-knife.rb 45 | Policyfile.lock.json 46 | 47 | # vagrant stuff 48 | .vagrant/ 49 | .vagrant.d/ 50 | -------------------------------------------------------------------------------- /attributes/default.rb: -------------------------------------------------------------------------------- 1 | # 2 | # Cookbook:: vim 3 | # Attributes:: default 4 | # 5 | # Copyright:: 2010-2019, Chef Software, Inc. 6 | # 7 | # Licensed under the Apache License, Version 2.0 (the "License"); 8 | # you may not use this file except in compliance with the License. 9 | # You may obtain a copy of the License at 10 | # 11 | # http://www.apache.org/licenses/LICENSE-2.0 12 | # 13 | # Unless required by applicable law or agreed to in writing, software 14 | # distributed under the License is distributed on an "AS IS" BASIS, 15 | # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 16 | # See the License for the specific language governing permissions and 17 | # limitations under the License. 18 | # 19 | 20 | default['vim']['extra_packages'] = [] 21 | default['vim']['install_method'] = 'package' 22 | -------------------------------------------------------------------------------- /spec/package_spec.rb: -------------------------------------------------------------------------------- 1 | require 'spec_helper' 2 | 3 | describe 'vim::default' do 4 | package_checks = { 5 | 'ubuntu' => { 6 | '16.04' => ['vim'], 7 | '18.04' => ['vim'], 8 | }, 9 | 'debian' => { 10 | '9' => ['vim'], 11 | '10' => ['vim'], 12 | }, 13 | } 14 | 15 | package_checks.each do |platform, versions| 16 | versions.each do |version, packages| 17 | packages.each do |package_name| 18 | it "should install #{package_name} on #{platform} #{version}" do 19 | chef_run = ChefSpec::SoloRunner.new(platform: platform, version: version, file_cache_path: '/var/chef/cache') do |node| 20 | node.normal['vim']['install_method'] = 'package' 21 | end.converge(described_recipe) 22 | expect(chef_run).to install_package(package_name) 23 | end 24 | end 25 | end 26 | end 27 | end 28 | -------------------------------------------------------------------------------- /kitchen.yml: -------------------------------------------------------------------------------- 1 | driver: 2 | name: vagrant 3 | 4 | provisioner: 5 | name: chef_zero 6 | deprecations_as_errors: true 7 | 8 | verifier: 9 | name: inspec 10 | 11 | platforms: 12 | - name: almalinux-8 13 | - name: amazonlinux-2 14 | - name: debian-10 15 | - name: debian-11 16 | - name: centos-7 17 | - name: centos-stream-8 18 | - name: fedora-latest 19 | - name: ubuntu-18.04 20 | - name: ubuntu-20.04 21 | - name: rockylinux-8 22 | - name: macosx-10.12 23 | run_list: homebrew::default 24 | driver: 25 | # private box in Chef's Atlas account 26 | box: chef/macosx-10.12 27 | provider: vmware_fusion 28 | 29 | suites: 30 | - name: package 31 | run_list: 32 | - recipe[vim::default] 33 | - name: source 34 | excludes: 35 | - macosx-10.12 36 | run_list: 37 | - recipe[vim::default] 38 | attributes: 39 | vim: 40 | install_method: source 41 | -------------------------------------------------------------------------------- /recipes/default.rb: -------------------------------------------------------------------------------- 1 | # 2 | # Cookbook:: vim 3 | # Recipe:: default 4 | # 5 | # Copyright:: 2010-2019, Chef Software, Inc. 6 | # 7 | # Licensed under the Apache License, Version 2.0 (the "License"); 8 | # you may not use this file except in compliance with the License. 9 | # You may obtain a copy of the License at 10 | # 11 | # http://www.apache.org/licenses/LICENSE-2.0 12 | # 13 | # Unless required by applicable law or agreed to in writing, software 14 | # distributed under the License is distributed on an "AS IS" BASIS, 15 | # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 16 | # See the License for the specific language governing permissions and 17 | # limitations under the License. 18 | # 19 | 20 | begin 21 | include_recipe "vim::#{node['vim']['install_method']}" 22 | rescue Chef::Exceptions::RecipeNotFound 23 | Chef::Log.warn "A vim recipe does not exist for the install method specified: #{node['vim']['install_method']}" 24 | end 25 | -------------------------------------------------------------------------------- /.github/workflows/stale.yml: -------------------------------------------------------------------------------- 1 | --- 2 | name: Mark stale issues and pull requests 3 | 4 | "on": 5 | schedule: [cron: "0 0 * * *"] 6 | 7 | jobs: 8 | stale: 9 | runs-on: ubuntu-latest 10 | steps: 11 | - uses: actions/stale@v10 12 | with: 13 | repo-token: ${{ secrets.GITHUB_TOKEN }} 14 | close-issue-message: > 15 | Closing due to inactivity. 16 | If this is still an issue please reopen or open another issue. 17 | Alternatively drop by the #sous-chefs channel on the [Chef Community Slack](http://community-slack.chef.io/) and we'll be happy to help! 18 | Thanks, Sous-Chefs. 19 | days-before-close: 7 20 | days-before-stale: 365 21 | stale-issue-message: > 22 | Marking stale due to inactivity. 23 | Remove stale label or comment or this will be closed in 7 days. 24 | Alternatively drop by the #sous-chefs channel on the [Chef Community Slack](http://community-slack.chef.io/) and we'll be happy to help! 25 | Thanks, Sous-Chefs. 26 | -------------------------------------------------------------------------------- /kitchen.global.yml: -------------------------------------------------------------------------------- 1 | --- 2 | provisioner: 3 | name: chef_infra 4 | product_name: chef 5 | product_version: <%= ENV['CHEF_VERSION'] || 'latest' %> 6 | channel: stable 7 | install_strategy: once 8 | chef_license: accept 9 | enforce_idempotency: <%= ENV['ENFORCE_IDEMPOTENCY'] || true %> 10 | multiple_converge: <%= ENV['MULTIPLE_CONVERGE'] || 2 %> 11 | deprecations_as_errors: true 12 | log_level: <%= ENV['CHEF_LOG_LEVEL'] || 'auto' %> 13 | 14 | verifier: 15 | name: inspec 16 | 17 | platforms: 18 | - name: almalinux-8 19 | - name: almalinux-9 20 | - name: amazonlinux-2023 21 | - name: centos-7 22 | - name: centos-stream-8 23 | - name: centos-stream-9 24 | - name: debian-9 25 | - name: debian-10 26 | - name: debian-11 27 | - name: debian-12 28 | - name: fedora-latest 29 | - name: opensuse-leap-15 30 | - name: oraclelinux-7 31 | - name: oraclelinux-8 32 | - name: oraclelinux-9 33 | - name: rockylinux-8 34 | - name: rockylinux-9 35 | - name: ubuntu-18.04 36 | - name: ubuntu-20.04 37 | - name: ubuntu-22.04 38 | - name: ubuntu-23.04 39 | -------------------------------------------------------------------------------- /spec/source_spec.rb: -------------------------------------------------------------------------------- 1 | require 'spec_helper' 2 | 3 | describe 'vim::source' do 4 | context 'on ubuntu' do 5 | platform 'ubuntu' 6 | 7 | it { is_expected.to install_package(['exuberant-ctags', 'gcc', 'libncurses5-dev', 'libperl-dev', 'lua5.1', 'make', 'python-dev', 'ruby-dev', 'tcl-dev', 'bzip2']) } 8 | end 9 | 10 | context 'on rhel 7' do 11 | platform 'redhat', '7' 12 | 13 | it { is_expected.to install_package(%w(ctags gcc lua-devel make ncurses-devel perl-devel perl-ExtUtils-CBuilder perl-ExtUtils-Embed perl-ExtUtils-ParseXS python-devel ruby-devel tcl-devel bzip2)) } 14 | end 15 | 16 | context 'on rhel 8' do 17 | platform 'redhat', '8' 18 | 19 | it { is_expected.to install_package(%w(ctags gcc lua-libs make ncurses-devel perl-devel perl-ExtUtils-CBuilder perl-ExtUtils-Embed perl-ExtUtils-ParseXS python3-libs ruby-devel tcl-devel bzip2)) } 20 | end 21 | 22 | context 'on sles' do 23 | platform 'suse' 24 | 25 | it { is_expected.to install_package(%w(ctags gcc lua-devel make ncurses-devel perl python-devel ruby-devel tcl-devel tar)) } 26 | end 27 | end 28 | -------------------------------------------------------------------------------- /recipes/package.rb: -------------------------------------------------------------------------------- 1 | # 2 | # Cookbook:: vim 3 | # Recipe:: package 4 | # 5 | # Copyright:: 2013-2019, Chef Software, Inc. 6 | # 7 | # Licensed under the Apache License, Version 2.0 (the "License"); 8 | # you may not use this file except in compliance with the License. 9 | # You may obtain a copy of the License at 10 | # 11 | # http://www.apache.org/licenses/LICENSE-2.0 12 | # 13 | # Unless required by applicable law or agreed to in writing, software 14 | # distributed under the License is distributed on an "AS IS" BASIS, 15 | # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 16 | # See the License for the specific language governing permissions and 17 | # limitations under the License. 18 | # 19 | # There is no vim package on RHEL/CentOS derivatives 20 | # * vim-minimal gives you /bin/vi 21 | # * vim-enhanced gives you /usr/bin/vim 22 | # 23 | vim_base_pkgs = value_for_platform_family( 24 | %w(debian arch) => ['vim'], 25 | %w(rhel fedora) => %w(vim-minimal vim-enhanced), 26 | 'default' => ['vim'] 27 | ) 28 | 29 | package vim_base_pkgs 30 | 31 | package node['vim']['extra_packages'] unless node['vim']['extra_packages'].empty? 32 | -------------------------------------------------------------------------------- /.github/workflows/ci.yml: -------------------------------------------------------------------------------- 1 | name: delivery 2 | 3 | "on": 4 | pull_request: 5 | push: 6 | branches: 7 | - main 8 | 9 | jobs: 10 | lint-unit: 11 | uses: sous-chefs/.github/.github/workflows/lint-unit.yml@5.0.3 12 | 13 | integration: 14 | needs: lint-unit 15 | runs-on: ubuntu-latest 16 | strategy: 17 | matrix: 18 | os: 19 | - almalinux-8 20 | - almalinux-9 21 | - amazonlinux-2023 22 | - debian-11 23 | - debian-12 24 | - centos-stream-8 25 | - centos-stream-9 26 | - fedora-latest 27 | - ubuntu-2004 28 | - ubuntu-2204 29 | suite: 30 | - package 31 | - source 32 | fail-fast: false 33 | steps: 34 | - name: Check out code 35 | uses: actions/checkout@v5 36 | - name: Install Chef 37 | uses: actionshub/chef-install@main 38 | - name: Dokken 39 | uses: actionshub/test-kitchen@main 40 | env: 41 | CHEF_LICENSE: accept-no-persist 42 | KITCHEN_LOCAL_YAML: kitchen.dokken.yml 43 | with: 44 | suite: ${{ matrix.suite }} 45 | os: ${{ matrix.os }} 46 | 47 | final: 48 | runs-on: ubuntu-latest 49 | needs: integration 50 | steps: 51 | - run: echo ${{needs.integration.outputs}} 52 | -------------------------------------------------------------------------------- /recipes/source.rb: -------------------------------------------------------------------------------- 1 | # 2 | # Cookbook:: vim 3 | # Recipe:: source 4 | # 5 | # Copyright:: 2013-2019, Chef Software, Inc. 6 | # 7 | # Licensed under the Apache License, Version 2.0 (the "License"); 8 | # you may not use this file except in compliance with the License. 9 | # You may obtain a copy of the License at 10 | # 11 | # http://www.apache.org/licenses/LICENSE-2.0 12 | # 13 | # Unless required by applicable law or agreed to in writing, software 14 | # distributed under the License is distributed on an "AS IS" BASIS, 15 | # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 16 | # See the License for the specific language governing permissions and 17 | # limitations under the License. 18 | # 19 | 20 | cache_path = Chef::Config['file_cache_path'] 21 | source_version = node['vim']['source']['version'] 22 | 23 | package node['vim']['source']['dependencies'] 24 | 25 | include_recipe 'vim::source_rhel' if platform_family?('fedora', 'rhel', 'amazon') 26 | 27 | remote_file "#{cache_path}/vim-#{source_version}.tar.bz2" do 28 | source "http://ftp.vim.org/pub/vim/unix/vim-#{source_version}.tar.bz2" 29 | checksum node['vim']['source']['checksum'] 30 | end 31 | 32 | bash 'install_vim' do 33 | cwd cache_path 34 | code <<-EOH 35 | mkdir vim-#{source_version} 36 | tar -jxf vim-#{source_version}.tar.bz2 -C vim-#{source_version} --strip-components 1 37 | (cd vim-#{source_version}/ && make clean && ./configure #{node['vim']['source']['configuration']} && make && make install) 38 | EOH 39 | creates "#{node['vim']['source']['prefix']}/bin/vim" 40 | end 41 | -------------------------------------------------------------------------------- /Dangerfile: -------------------------------------------------------------------------------- 1 | # Reference: http://danger.systems/reference.html 2 | 3 | # A pull request summary is required. Add a description of the pull request purpose. 4 | # Changelog must be updated for each pull request that changes code. 5 | # Warnings will be issued for: 6 | # Pull request with more than 400 lines of code changed 7 | # Pull reqest that change more than 5 lines without test changes 8 | # Failures will be issued for: 9 | # Pull request without summary 10 | # Pull requests with code changes without changelog entry 11 | 12 | def code_changes? 13 | code = %w(libraries attributes recipes resources files templates) 14 | code.each do |location| 15 | return true unless git.modified_files.grep(/#{location}/).empty? 16 | end 17 | false 18 | end 19 | 20 | def test_changes? 21 | tests = %w(spec test kitchen.yml kitchen.dokken.yml) 22 | tests.each do |location| 23 | return true unless git.modified_files.grep(/#{location}/).empty? 24 | end 25 | false 26 | end 27 | 28 | failure 'Please provide a summary of your Pull Request.' if github.pr_body.length < 10 29 | 30 | warn 'This is a big Pull Request.' if git.lines_of_code > 400 31 | 32 | warn 'This is a Table Flip.' if git.lines_of_code > 2000 33 | 34 | # Require a CHANGELOG entry for non-test changes. 35 | if !git.modified_files.include?('CHANGELOG.md') && code_changes? 36 | failure 'Please include a CHANGELOG entry.' 37 | end 38 | 39 | # Require Major Minor Patch version labels 40 | unless github.pr_labels.grep /minor|major|patch/i 41 | warn 'Please add a release label to this pull request' 42 | end 43 | 44 | # A sanity check for tests. 45 | if git.lines_of_code > 5 && code_changes? && !test_changes? 46 | warn 'This Pull Request is probably missing tests.' 47 | end 48 | -------------------------------------------------------------------------------- /chefignore: -------------------------------------------------------------------------------- 1 | # Put files/directories that should be ignored in this file when uploading 2 | # to a Chef Infra Server or Supermarket. 3 | # Lines that start with '# ' are comments. 4 | 5 | # OS generated files # 6 | ###################### 7 | .DS_Store 8 | ehthumbs.db 9 | Icon? 10 | nohup.out 11 | Thumbs.db 12 | .envrc 13 | 14 | # EDITORS # 15 | ########### 16 | .#* 17 | .project 18 | .settings 19 | *_flymake 20 | *_flymake.* 21 | *.bak 22 | *.sw[a-z] 23 | *.tmproj 24 | *~ 25 | \#* 26 | REVISION 27 | TAGS* 28 | tmtags 29 | .vscode 30 | .editorconfig 31 | 32 | ## COMPILED ## 33 | ############## 34 | *.class 35 | *.com 36 | *.dll 37 | *.exe 38 | *.o 39 | *.pyc 40 | *.so 41 | */rdoc/ 42 | a.out 43 | mkmf.log 44 | 45 | # Testing # 46 | ########### 47 | .circleci/* 48 | .codeclimate.yml 49 | .delivery/* 50 | .foodcritic 51 | .kitchen* 52 | .mdlrc 53 | .overcommit.yml 54 | .rspec 55 | .rubocop.yml 56 | .travis.yml 57 | .watchr 58 | .yamllint 59 | azure-pipelines.yml 60 | Dangerfile 61 | examples/* 62 | features/* 63 | Guardfile 64 | kitchen*.yml 65 | mlc_config.json 66 | Procfile 67 | Rakefile 68 | spec/* 69 | test/* 70 | 71 | # SCM # 72 | ####### 73 | .git 74 | .gitattributes 75 | .gitconfig 76 | .github/* 77 | .gitignore 78 | .gitkeep 79 | .gitmodules 80 | .svn 81 | */.bzr/* 82 | */.git 83 | */.hg/* 84 | */.svn/* 85 | 86 | # Berkshelf # 87 | ############# 88 | Berksfile 89 | Berksfile.lock 90 | cookbooks/* 91 | tmp 92 | 93 | # Bundler # 94 | ########### 95 | vendor/* 96 | Gemfile 97 | Gemfile.lock 98 | 99 | # Policyfile # 100 | ############## 101 | Policyfile.rb 102 | Policyfile.lock.json 103 | 104 | # Documentation # 105 | ############# 106 | CODE_OF_CONDUCT* 107 | CONTRIBUTING* 108 | documentation/* 109 | TESTING* 110 | UPGRADING* 111 | 112 | # Vagrant # 113 | ########### 114 | .vagrant 115 | Vagrantfile 116 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # vim Cookbook 2 | 3 | [![Build Status](https://travis-ci.org/chef-cookbooks/vim.svg?branch=master)](https://travis-ci.org/chef-cookbooks/vim) [![Cookbook Version](https://img.shields.io/cookbook/v/vim.svg)](https://supermarket.chef.io/cookbooks/vim) 4 | 5 | Installs or compiles/installs vim. 6 | 7 | ## Requirements 8 | 9 | ### Platforms 10 | 11 | - Ubuntu/Debian (source installs on Ubuntu 16.04 fail due to a vim bug) 12 | - RHEL/CentOS/Scientific/Amazon/Oracle 13 | - Fedora 14 | - openSUSE / SUSE Linux Enterprises 15 | 16 | ### Chef 17 | 18 | - Chef 12.1+ 19 | 20 | ### Cookbooks 21 | 22 | - none 23 | 24 | ## Attributes 25 | 26 | ### Default recipe attributes 27 | 28 | - `node['vim']['extra_packages']` - An array of extra packages related to vim to install (like plugins). Empty array by default. 29 | 30 | - `node['vim']['install_method']` - Sets the install method, choose from the various install recipes. This attribute is set to 'package' by default. 31 | 32 | ### Source recipe attributes 33 | 34 | - `node['vim']['source']['version']` - The version of vim to compile, 7.4 by default. 35 | - `node['vim']['source']['checksum']` - The source file checksum. 36 | - `node['vim']['source']['dependencies']` - These are the non rhl specific devel dependencies for compiling vim. 37 | - `node['vim']['source']['centos_dependencies']` - These are the rhl and centos specific dependencies needed for compiling vim. 38 | - `node['vim']['source']['prefix']` - This is the path the vim bin will be placed, it's `/usr/local` 39 | - `node['vim']['source']['configuration']` - If you prefer to compile vim differently than the default you can override this configuration. 40 | 41 | ## Usage 42 | 43 | Add `recipe[vim]` to your run list or include the default recipe with `include_recipe 'vim'` in a recipe that is in your run list. 44 | 45 | This uses the value of the attribute `node['vim']['install_method']` which by default is _package_. 46 | 47 | If you would like to install additional vim plugin packages, include their package names in the `node['vim']['extra_packages']` attribute. Verify that your operating sytem has the package available. 48 | 49 | If you would rather compile vim from source, as the case may be for centos nodes, then override the `node['vim']['install_method']` with a value of `'source'`. 50 | 51 | ## License & Authors 52 | 53 | **Author:** Cookbook Engineering Team ([cookbooks@chef.io](mailto:cookbooks@chef.io)) 54 | 55 | **Copyright:** 2008-2016, Chef Software, Inc. 56 | 57 | ``` 58 | Licensed under the Apache License, Version 2.0 (the "License"); 59 | you may not use this file except in compliance with the License. 60 | You may obtain a copy of the License at 61 | 62 | http://www.apache.org/licenses/LICENSE-2.0 63 | 64 | Unless required by applicable law or agreed to in writing, software 65 | distributed under the License is distributed on an "AS IS" BASIS, 66 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 67 | See the License for the specific language governing permissions and 68 | limitations under the License. 69 | ``` 70 | -------------------------------------------------------------------------------- /kitchen.dokken.yml: -------------------------------------------------------------------------------- 1 | driver: 2 | name: dokken 3 | privileged: true 4 | chef_version: <%= ENV['CHEF_VERSION'] || 'current' %> 5 | 6 | transport: { name: dokken } 7 | provisioner: { name: dokken } 8 | 9 | platforms: 10 | - name: almalinux-8 11 | driver: 12 | image: dokken/almalinux-8 13 | pid_one_command: /usr/lib/systemd/systemd 14 | 15 | - name: almalinux-9 16 | driver: 17 | image: dokken/almalinux-9 18 | pid_one_command: /usr/lib/systemd/systemd 19 | 20 | - name: amazonlinux-2023 21 | driver: 22 | image: dokken/amazonlinux-2023 23 | pid_one_command: /usr/lib/systemd/systemd 24 | 25 | - name: centos-7 26 | driver: 27 | image: dokken/centos-7 28 | pid_one_command: /usr/lib/systemd/systemd 29 | 30 | - name: centos-stream-8 31 | driver: 32 | image: dokken/centos-stream-8 33 | pid_one_command: /usr/lib/systemd/systemd 34 | 35 | - name: centos-stream-9 36 | driver: 37 | image: dokken/centos-stream-9 38 | pid_one_command: /usr/lib/systemd/systemd 39 | 40 | - name: debian-9 41 | driver: 42 | image: dokken/debian-9 43 | pid_one_command: /bin/systemd 44 | 45 | - name: debian-10 46 | driver: 47 | image: dokken/debian-10 48 | pid_one_command: /bin/systemd 49 | 50 | - name: debian-11 51 | driver: 52 | image: dokken/debian-11 53 | pid_one_command: /bin/systemd 54 | 55 | - name: debian-12 56 | driver: 57 | image: dokken/debian-12 58 | pid_one_command: /bin/systemd 59 | 60 | - name: fedora-latest 61 | driver: 62 | image: dokken/fedora-latest 63 | pid_one_command: /usr/lib/systemd/systemd 64 | 65 | - name: opensuse-leap-15 66 | driver: 67 | image: dokken/opensuse-leap-15 68 | pid_one_command: /usr/lib/systemd/systemd 69 | 70 | - name: oraclelinux-7 71 | driver: 72 | image: dokken/oraclelinux-7 73 | pid_one_command: /usr/lib/systemd/systemd 74 | 75 | - name: oraclelinux-8 76 | driver: 77 | image: dokken/oraclelinux-8 78 | pid_one_command: /usr/lib/systemd/systemd 79 | 80 | - name: oraclelinux-9 81 | driver: 82 | image: dokken/oraclelinux-9 83 | pid_one_command: /usr/lib/systemd/systemd 84 | 85 | - name: rockylinux-8 86 | driver: 87 | image: dokken/rockylinux-8 88 | pid_one_command: /usr/lib/systemd/systemd 89 | 90 | - name: rockylinux-9 91 | driver: 92 | image: dokken/rockylinux-9 93 | pid_one_command: /usr/lib/systemd/systemd 94 | 95 | - name: ubuntu-18.04 96 | driver: 97 | image: dokken/ubuntu-18.04 98 | pid_one_command: /bin/systemd 99 | 100 | - name: ubuntu-20.04 101 | driver: 102 | image: dokken/ubuntu-20.04 103 | pid_one_command: /bin/systemd 104 | 105 | - name: ubuntu-22.04 106 | driver: 107 | image: dokken/ubuntu-22.04 108 | pid_one_command: /bin/systemd 109 | 110 | - name: ubuntu-23.04 111 | driver: 112 | image: dokken/ubuntu-23.04 113 | pid_one_command: /bin/systemd 114 | -------------------------------------------------------------------------------- /CHANGELOG.md: -------------------------------------------------------------------------------- 1 | # vim Cookbook CHANGELOG 2 | 3 | This file is used to list changes made in each version of the vim cookbook. 4 | 5 | ## [3.0.3](https://github.com/sous-chefs/vim/compare/3.0.2...v3.0.3) (2025-10-16) 6 | 7 | 8 | ### Bug Fixes 9 | 10 | * **ci:** Update workflows to use release pipeline ([#66](https://github.com/sous-chefs/vim/issues/66)) ([cc96096](https://github.com/sous-chefs/vim/commit/cc960960dfeeb5c10ba8f1832692d3474e28f589)) 11 | 12 | ## 3.0.1 - *2024-05-20* 13 | 14 | * resolved cookstyle error: metadata.rb:24:1 convention: `Layout/TrailingEmptyLines` 15 | 16 | ## 3.0.0 - *2024-05-06* 17 | 18 | * Adopt cookbook 19 | 20 | ## 2.1.15 - *2023-04-07* 21 | 22 | Standardise files with files in sous-chefs/repo-management 23 | 24 | ## 2.1.12 - *2023-04-01* 25 | 26 | Standardise files with files in sous-chefs/repo-management 27 | 28 | ## 2.1.11 - *2023-03-20* 29 | 30 | Standardise files with files in sous-chefs/repo-management 31 | 32 | ## 2.1.10 - *2023-03-15* 33 | 34 | Standardise files with files in sous-chefs/repo-management 35 | 36 | ## 2.1.8 - *2023-02-23* 37 | 38 | Standardise files with files in sous-chefs/repo-management 39 | 40 | ## 2.1.6 - *2023-02-14* 41 | 42 | Standardise files with files in sous-chefs/repo-management 43 | 44 | ## 2.1.5 - *2022-12-15* 45 | 46 | Standardise files with files in sous-chefs/repo-management 47 | 48 | Standardise files with files in sous-chefs/repo-management 49 | 50 | ## 2.1.4 - *2022-02-07* 51 | 52 | * Remove delivery and move to calling RSpec directly via a reusable workflow 53 | * Update tested platforms 54 | * Standardise files with files in sous-chefs/repo-management 55 | 56 | ## 2.1.3 - *2021-08-30* 57 | 58 | * Standardise files with files in sous-chefs/repo-management 59 | 60 | ## 2.1.2 - *2021-06-01* 61 | 62 | * Standardise files with files in sous-chefs/repo-management 63 | 64 | ## 2.1.1 - *2021-05-28* 65 | 66 | * Fix builds 67 | 68 | ## 2.1.0 (2020-01-10) 69 | 70 | * Remove chef 11 compat in metadata - [@tas50](https://github.com/tas50) 71 | * Add support for SLES / opensuse for source installs - [@tas50](https://github.com/tas50) 72 | * Resolve Cookstyle 5.8 warnings - [@tas50](https://github.com/tas50) 73 | * Require Chef 12.15+ - [@tas50](https://github.com/tas50) 74 | * Remove RHEL 5 support for source installs - [@tas50](https://github.com/tas50) 75 | * Add Amazon Linux support for source installs - [@tas50](https://github.com/tas50) 76 | * Update to vim 8.2 for source installs - [@tas50](https://github.com/tas50) 77 | * Fix source installs on RHEL 8 - [@tas50](https://github.com/tas50) 78 | 79 | ## 2.0.2 (2016-08-30) 80 | 81 | * Add IBM zLinux to metadata 82 | * Use kitchen-dokken in Travis CI and test on more Platforms 83 | * Update specs with new platforms 84 | * Remove Chef 11 compatibility 85 | * Add chef_version to metadata 86 | 87 | ## v2.0.1 (2016-02-22) 88 | 89 | * add missing bzip2 package to fix source recipe. 90 | 91 | ## v2.0.0 (2015-10-01) 92 | 93 | * Use multi-package installs introduced in Chef 12.1 to simplify code and speed up installs 94 | * Add Fedora source install support 95 | * Fix CentOS source install support and ensure vim compiles correctly on CentOS 5/6/7 96 | * Fix the tarball checksum to be the actual SHA256 checksum 97 | * Enable lua, perl, tcl support in the source install and add the necessary development packages for that support 98 | * Use the correct ctags package on Debian/Ubuntu systems to prevent errors or warnings 99 | * Improve how the code compilation runs in source installs so that a failed run doesn't prevent subsequent Chef runs or introduce a state where vim is never compiled 100 | * Add basic Serverspec test for source installs to ensure that vim runs 101 | * Fixed the error message is a bad install_method attribute is given to describe the actual problema and vim cookbook 102 | 103 | ## v1.1.4 (2015-09-21) 104 | 105 | * Converted value_for_platform to value_for_platform_family in order to support all RHEL and Debian derivitives 106 | * Added a Kitchen CI config for integration testing 107 | * Updated Travis to test on the latest ruby versions and to perform Chefspec tests 108 | * Updated Berkfile to 3.X format 109 | * Added updated CONTRIBUTING.MD, TESTING.MD and MAINTAINERS.MD files 110 | * Added Chefspec tests to get coverage to 100% 111 | * Added an expanded .gitignore and a chefignore file to limit the files uploaded to the chef-server 112 | * Added a Rakefile for simplified testing 113 | * Resolved rubocop warnings 114 | * Added Oracle Linux and Amazon Linux to the metadata file 115 | * Updated development dependencies 116 | * Updated Kitchen config to work with the latest in Chef DK 117 | 118 | ## v1.1.2 (2013-12-30) 119 | 120 | * Fixed Ubuntu package installer bug. Adding specs. 121 | 122 | ## v1.1.0 123 | 124 | ### Improvement 125 | 126 | * Add a compile and settings optional recipe. 127 | -------------------------------------------------------------------------------- /attributes/source.rb: -------------------------------------------------------------------------------- 1 | # 2 | # Cookbook:: vim 3 | # Attributes:: source 4 | # 5 | # Copyright:: 2013-2020, Chef Software, Inc. 6 | # 7 | # Licensed under the Apache License, Version 2.0 (the "License"); 8 | # you may not use this file except in compliance with the License. 9 | # You may obtain a copy of the License at 10 | # 11 | # http://www.apache.org/licenses/LICENSE-2.0 12 | # 13 | # Unless required by applicable law or agreed to in writing, software 14 | # distributed under the License is distributed on an "AS IS" BASIS, 15 | # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 16 | # See the License for the specific language governing permissions and 17 | # limitations under the License. 18 | # 19 | 20 | default['vim']['source']['version'] = '8.2' 21 | default['vim']['source']['checksum'] = 'f087f821831b4fece16a0461d574ccd55a8279f64d635510a1e10225966ced3b' 22 | default['vim']['source']['prefix'] = '/usr/local' 23 | default['vim']['source']['configuration'] = "--without-x --enable-pythoninterp --enable-rubyinterp --enable-tclinterp --enable-luainterp --enable-perlinterp --enable-cscope --with-features=huge --prefix=#{default['vim']['source']['prefix']}" 24 | 25 | default['vim']['source']['dependencies'] = if platform_family?('rhel', 'fedora', 'amazon') 26 | if platform_family?('rhel') && node['platform_version'].to_i >= 8 27 | %w( ctags 28 | gcc 29 | lua-libs 30 | make 31 | ncurses-devel 32 | perl-devel 33 | perl-ExtUtils-CBuilder 34 | perl-ExtUtils-Embed 35 | perl-ExtUtils-ParseXS 36 | python3-libs 37 | ruby-devel 38 | tcl-devel 39 | bzip2 40 | ) 41 | else 42 | %w( ctags 43 | gcc 44 | lua-devel 45 | make 46 | ncurses-devel 47 | perl-devel 48 | perl-ExtUtils-CBuilder 49 | perl-ExtUtils-Embed 50 | perl-ExtUtils-ParseXS 51 | python-devel 52 | ruby-devel 53 | tcl-devel 54 | bzip2 55 | ) 56 | 57 | end 58 | elsif platform_family?('suse') 59 | %w( ctags 60 | gcc 61 | lua-devel 62 | make 63 | ncurses-devel 64 | perl 65 | python-devel 66 | ruby-devel 67 | tcl-devel 68 | tar 69 | ) 70 | else 71 | %w( exuberant-ctags 72 | gcc 73 | libncurses5-dev 74 | libperl-dev 75 | lua5.1 76 | make 77 | python-dev 78 | ruby-dev 79 | tcl-dev 80 | bzip2 81 | ) 82 | end 83 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | Apache License 2 | Version 2.0, January 2004 3 | http://www.apache.org/licenses/ 4 | 5 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 6 | 7 | 1. Definitions. 8 | 9 | "License" shall mean the terms and conditions for use, reproduction, 10 | and distribution as defined by Sections 1 through 9 of this document. 11 | 12 | "Licensor" shall mean the copyright owner or entity authorized by 13 | the copyright owner that is granting the License. 14 | 15 | "Legal Entity" shall mean the union of the acting entity and all 16 | other entities that control, are controlled by, or are under common 17 | control with that entity. For the purposes of this definition, 18 | "control" means (i) the power, direct or indirect, to cause the 19 | direction or management of such entity, whether by contract or 20 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 21 | outstanding shares, or (iii) beneficial ownership of such entity. 22 | 23 | "You" (or "Your") shall mean an individual or Legal Entity 24 | exercising permissions granted by this License. 25 | 26 | "Source" form shall mean the preferred form for making modifications, 27 | including but not limited to software source code, documentation 28 | source, and configuration files. 29 | 30 | "Object" form shall mean any form resulting from mechanical 31 | transformation or translation of a Source form, including but 32 | not limited to compiled object code, generated documentation, 33 | and conversions to other media types. 34 | 35 | "Work" shall mean the work of authorship, whether in Source or 36 | Object form, made available under the License, as indicated by a 37 | copyright notice that is included in or attached to the work 38 | (an example is provided in the Appendix below). 39 | 40 | "Derivative Works" shall mean any work, whether in Source or Object 41 | form, that is based on (or derived from) the Work and for which the 42 | editorial revisions, annotations, elaborations, or other modifications 43 | represent, as a whole, an original work of authorship. For the purposes 44 | of this License, Derivative Works shall not include works that remain 45 | separable from, or merely link (or bind by name) to the interfaces of, 46 | the Work and Derivative Works thereof. 47 | 48 | "Contribution" shall mean any work of authorship, including 49 | the original version of the Work and any modifications or additions 50 | to that Work or Derivative Works thereof, that is intentionally 51 | submitted to Licensor for inclusion in the Work by the copyright owner 52 | or by an individual or Legal Entity authorized to submit on behalf of 53 | the copyright owner. For the purposes of this definition, "submitted" 54 | means any form of electronic, verbal, or written communication sent 55 | to the Licensor or its representatives, including but not limited to 56 | communication on electronic mailing lists, source code control systems, 57 | and issue tracking systems that are managed by, or on behalf of, the 58 | Licensor for the purpose of discussing and improving the Work, but 59 | excluding communication that is conspicuously marked or otherwise 60 | designated in writing by the copyright owner as "Not a Contribution." 61 | 62 | "Contributor" shall mean Licensor and any individual or Legal Entity 63 | on behalf of whom a Contribution has been received by Licensor and 64 | subsequently incorporated within the Work. 65 | 66 | 2. Grant of Copyright License. Subject to the terms and conditions of 67 | this License, each Contributor hereby grants to You a perpetual, 68 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 69 | copyright license to reproduce, prepare Derivative Works of, 70 | publicly display, publicly perform, sublicense, and distribute the 71 | Work and such Derivative Works in Source or Object form. 72 | 73 | 3. Grant of Patent License. Subject to the terms and conditions of 74 | this License, each Contributor hereby grants to You a perpetual, 75 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 76 | (except as stated in this section) patent license to make, have made, 77 | use, offer to sell, sell, import, and otherwise transfer the Work, 78 | where such license applies only to those patent claims licensable 79 | by such Contributor that are necessarily infringed by their 80 | Contribution(s) alone or by combination of their Contribution(s) 81 | with the Work to which such Contribution(s) was submitted. If You 82 | institute patent litigation against any entity (including a 83 | cross-claim or counterclaim in a lawsuit) alleging that the Work 84 | or a Contribution incorporated within the Work constitutes direct 85 | or contributory patent infringement, then any patent licenses 86 | granted to You under this License for that Work shall terminate 87 | as of the date such litigation is filed. 88 | 89 | 4. Redistribution. You may reproduce and distribute copies of the 90 | Work or Derivative Works thereof in any medium, with or without 91 | modifications, and in Source or Object form, provided that You 92 | meet the following conditions: 93 | 94 | (a) You must give any other recipients of the Work or 95 | Derivative Works a copy of this License; and 96 | 97 | (b) You must cause any modified files to carry prominent notices 98 | stating that You changed the files; and 99 | 100 | (c) You must retain, in the Source form of any Derivative Works 101 | that You distribute, all copyright, patent, trademark, and 102 | attribution notices from the Source form of the Work, 103 | excluding those notices that do not pertain to any part of 104 | the Derivative Works; and 105 | 106 | (d) If the Work includes a "NOTICE" text file as part of its 107 | distribution, then any Derivative Works that You distribute must 108 | include a readable copy of the attribution notices contained 109 | within such NOTICE file, excluding those notices that do not 110 | pertain to any part of the Derivative Works, in at least one 111 | of the following places: within a NOTICE text file distributed 112 | as part of the Derivative Works; within the Source form or 113 | documentation, if provided along with the Derivative Works; or, 114 | within a display generated by the Derivative Works, if and 115 | wherever such third-party notices normally appear. The contents 116 | of the NOTICE file are for informational purposes only and 117 | do not modify the License. You may add Your own attribution 118 | notices within Derivative Works that You distribute, alongside 119 | or as an addendum to the NOTICE text from the Work, provided 120 | that such additional attribution notices cannot be construed 121 | as modifying the License. 122 | 123 | You may add Your own copyright statement to Your modifications and 124 | may provide additional or different license terms and conditions 125 | for use, reproduction, or distribution of Your modifications, or 126 | for any such Derivative Works as a whole, provided Your use, 127 | reproduction, and distribution of the Work otherwise complies with 128 | the conditions stated in this License. 129 | 130 | 5. Submission of Contributions. Unless You explicitly state otherwise, 131 | any Contribution intentionally submitted for inclusion in the Work 132 | by You to the Licensor shall be under the terms and conditions of 133 | this License, without any additional terms or conditions. 134 | Notwithstanding the above, nothing herein shall supersede or modify 135 | the terms of any separate license agreement you may have executed 136 | with Licensor regarding such Contributions. 137 | 138 | 6. Trademarks. This License does not grant permission to use the trade 139 | names, trademarks, service marks, or product names of the Licensor, 140 | except as required for reasonable and customary use in describing the 141 | origin of the Work and reproducing the content of the NOTICE file. 142 | 143 | 7. Disclaimer of Warranty. Unless required by applicable law or 144 | agreed to in writing, Licensor provides the Work (and each 145 | Contributor provides its Contributions) on an "AS IS" BASIS, 146 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 147 | implied, including, without limitation, any warranties or conditions 148 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 149 | PARTICULAR PURPOSE. You are solely responsible for determining the 150 | appropriateness of using or redistributing the Work and assume any 151 | risks associated with Your exercise of permissions under this License. 152 | 153 | 8. Limitation of Liability. In no event and under no legal theory, 154 | whether in tort (including negligence), contract, or otherwise, 155 | unless required by applicable law (such as deliberate and grossly 156 | negligent acts) or agreed to in writing, shall any Contributor be 157 | liable to You for damages, including any direct, indirect, special, 158 | incidental, or consequential damages of any character arising as a 159 | result of this License or out of the use or inability to use the 160 | Work (including but not limited to damages for loss of goodwill, 161 | work stoppage, computer failure or malfunction, or any and all 162 | other commercial damages or losses), even if such Contributor 163 | has been advised of the possibility of such damages. 164 | 165 | 9. Accepting Warranty or Additional Liability. While redistributing 166 | the Work or Derivative Works thereof, You may choose to offer, 167 | and charge a fee for, acceptance of support, warranty, indemnity, 168 | or other liability obligations and/or rights consistent with this 169 | License. However, in accepting such obligations, You may act only 170 | on Your own behalf and on Your sole responsibility, not on behalf 171 | of any other Contributor, and only if You agree to indemnify, 172 | defend, and hold each Contributor harmless for any liability 173 | incurred by, or claims asserted against, such Contributor by reason 174 | of your accepting any such warranty or additional liability. 175 | 176 | END OF TERMS AND CONDITIONS 177 | 178 | APPENDIX: How to apply the Apache License to your work. 179 | 180 | To apply the Apache License to your work, attach the following 181 | boilerplate notice, with the fields enclosed by brackets "{}" 182 | replaced with your own identifying information. (Don't include 183 | the brackets!) The text should be enclosed in the appropriate 184 | comment syntax for the file format. We also recommend that a 185 | file or class name and description of purpose be included on the 186 | same "printed page" as the copyright notice for easier 187 | identification within third-party archives. 188 | 189 | Copyright {yyyy} {name of copyright owner} 190 | 191 | Licensed under the Apache License, Version 2.0 (the "License"); 192 | you may not use this file except in compliance with the License. 193 | You may obtain a copy of the License at 194 | 195 | http://www.apache.org/licenses/LICENSE-2.0 196 | 197 | Unless required by applicable law or agreed to in writing, software 198 | distributed under the License is distributed on an "AS IS" BASIS, 199 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 200 | See the License for the specific language governing permissions and 201 | limitations under the License. 202 | 203 | --------------------------------------------------------------------------------