├── .gitignore ├── .github ├── labeler.yml ├── CODEOWNERS ├── workflows │ ├── labeler.yml │ ├── markdownlint.yml │ ├── release.yml │ ├── shellcheck.yml │ ├── security_scanning.yml │ ├── ci.yaml │ └── build_container.yml ├── dependabot.yml └── release.yml ├── .markdownlint-cli2.yaml ├── .markdownlint.yaml ├── Gemfile ├── CONTRIBUTING.md ├── matrix.sh ├── Rakefile ├── voxbox ├── Rakefile └── Gemfile ├── RELEASE.md ├── renovate.json ├── .gitlab-ci.yml ├── evb ├── Containerfile ├── CHANGELOG.md ├── README.md └── LICENSE /.gitignore: -------------------------------------------------------------------------------- 1 | # Managed by modulesync - DO NOT EDIT 2 | # https://voxpupuli.org/docs/updating-files-managed-with-modulesync/ 3 | 4 | .bundle/ 5 | .vendor/ 6 | vendor/ 7 | Gemfile.lock 8 | -------------------------------------------------------------------------------- /.github/labeler.yml: -------------------------------------------------------------------------------- 1 | --- 2 | # Managed by modulesync - DO NOT EDIT 3 | # https://voxpupuli.org/docs/updating-files-managed-with-modulesync/ 4 | 5 | skip-changelog: 6 | - head-branch: ['^release-*'] 7 | -------------------------------------------------------------------------------- /.github/CODEOWNERS: -------------------------------------------------------------------------------- 1 | # Managed by modulesync - DO NOT EDIT 2 | # https://voxpupuli.org/docs/updating-files-managed-with-modulesync/ 3 | 4 | # No matter which file got changed, request a review from the main developers 5 | * @voxpupuli/container-maintainers 6 | -------------------------------------------------------------------------------- /.markdownlint-cli2.yaml: -------------------------------------------------------------------------------- 1 | --- 2 | # Managed by modulesync - DO NOT EDIT 3 | # https://voxpupuli.org/docs/updating-files-managed-with-modulesync/ 4 | 5 | ignores: 6 | - .github/** 7 | - .idea/** 8 | - .vendor/** 9 | - .vscode/** 10 | - CHANGELOG.md 11 | - test/** 12 | - vendor/** 13 | -------------------------------------------------------------------------------- /.markdownlint.yaml: -------------------------------------------------------------------------------- 1 | --- 2 | # Managed by modulesync - DO NOT EDIT 3 | # https://voxpupuli.org/docs/updating-files-managed-with-modulesync/ 4 | 5 | default: true 6 | 7 | line-length: 8 | line_length: 210 9 | 10 | no-inline-html: 11 | allowed_elements: 12 | - br 13 | 14 | descriptive-link-text: false 15 | -------------------------------------------------------------------------------- /Gemfile: -------------------------------------------------------------------------------- 1 | # frozen_string_literal: true 2 | 3 | # Managed by modulesync - DO NOT EDIT 4 | # https://voxpupuli.org/docs/updating-files-managed-with-modulesync/ 5 | 6 | source ENV['GEM_SOURCE'] || 'https://rubygems.org' 7 | 8 | group :release do 9 | gem 'faraday-retry', '~> 2.1', require: false 10 | gem 'github_changelog_generator', '~> 1.16.4', require: false 11 | end 12 | -------------------------------------------------------------------------------- /CONTRIBUTING.md: -------------------------------------------------------------------------------- 1 | # How to contribute 2 | 3 | PRs are very welcome! 4 | 5 | ## Adding code 6 | 7 | - Create a fork 8 | - Create a branch 9 | - Do your thing 10 | - [Please sign all your commits](https://docs.github.com/de/authentication/managing-commit-signature-verification) 11 | - Create a PR 12 | - Reference issues if applicable 13 | 14 | ## Found a bug? 15 | 16 | - Please open an issue 17 | - If you are able to fix it you also can open a PR (see above) 18 | -------------------------------------------------------------------------------- /.github/workflows/labeler.yml: -------------------------------------------------------------------------------- 1 | --- 2 | # Managed by modulesync - DO NOT EDIT 3 | # https://voxpupuli.org/docs/updating-files-managed-with-modulesync/ 4 | 5 | name: 🏷️ Pull Request Labeler 6 | 7 | on: 8 | - pull_request_target 9 | 10 | permissions: 11 | contents: read 12 | 13 | jobs: 14 | labeler: 15 | name: Labeler 16 | runs-on: ubuntu-latest 17 | if: github.repository_owner == 'voxpupuli' 18 | permissions: 19 | pull-requests: write 20 | steps: 21 | - uses: actions/labeler@v6 22 | -------------------------------------------------------------------------------- /.github/workflows/markdownlint.yml: -------------------------------------------------------------------------------- 1 | --- 2 | # Managed by modulesync - DO NOT EDIT 3 | # https://voxpupuli.org/docs/updating-files-managed-with-modulesync/ 4 | 5 | name: Markdown Lint 6 | 7 | on: 8 | pull_request: 9 | branches: 10 | - main 11 | workflow_dispatch: 12 | 13 | permissions: 14 | contents: read 15 | 16 | jobs: 17 | markdown-lint: 18 | runs-on: ubuntu-latest 19 | steps: 20 | - uses: actions/checkout@v6 21 | - uses: DavidAnson/markdownlint-cli2-action@v22 22 | with: 23 | globs: '**/*.md' 24 | -------------------------------------------------------------------------------- /.github/workflows/release.yml: -------------------------------------------------------------------------------- 1 | --- 2 | # Managed by modulesync - DO NOT EDIT 3 | # https://voxpupuli.org/docs/updating-files-managed-with-modulesync/ 4 | 5 | name: 🚀 Release 6 | 7 | on: 8 | push: 9 | tags: 10 | - '*' 11 | 12 | permissions: 13 | contents: read 14 | 15 | jobs: 16 | release: 17 | name: Release 18 | runs-on: ubuntu-latest 19 | permissions: 20 | contents: write 21 | steps: 22 | - name: Create Release 23 | env: 24 | GH_TOKEN: ${{ github.token }} 25 | run: gh release create --repo ${{ github.repository }} ${{ github.ref_name }} --generate-notes 26 | -------------------------------------------------------------------------------- /.github/dependabot.yml: -------------------------------------------------------------------------------- 1 | --- 2 | # Managed by modulesync - DO NOT EDIT 3 | # https://voxpupuli.org/docs/updating-files-managed-with-modulesync/ 4 | 5 | version: 2 6 | updates: 7 | # raise PRs for gem updates 8 | - package-ecosystem: bundler 9 | directory: "/" 10 | schedule: 11 | interval: daily 12 | time: "13:00" 13 | open-pull-requests-limit: 10 14 | 15 | # Maintain dependencies for GitHub Actions 16 | - package-ecosystem: github-actions 17 | directory: "/" 18 | schedule: 19 | interval: daily 20 | time: "13:00" 21 | open-pull-requests-limit: 10 22 | 23 | - package-ecosystem: "docker" 24 | directory: "/" 25 | schedule: 26 | interval: "daily" 27 | time: "13:00" 28 | open-pull-requests-limit: 10 29 | -------------------------------------------------------------------------------- /matrix.sh: -------------------------------------------------------------------------------- 1 | #!/bin/bash 2 | 3 | yq -o=json build_platforms.yaml > build_platforms.json 4 | yq -o=json build_versions.yaml > build_versions.json 5 | 6 | if [ "$1" == "build" ]; then 7 | jq -rc --slurp '{ include: [ .[1].include[] as $i | .[0].platforms[] as $p | $i + {"platform": $p.platform, "runner": $p.runner} ] }' build_platforms.json build_versions.json 8 | fi 9 | 10 | if [ "$1" == "tag" ]; then 11 | # jq -s '(.[0].platforms[] | .platform) as $platform | (.[1].include[] | .openvox_release) as $release | { openvox_release: $release, platform: $platform }' build_platforms.json build_versions.json | jq -s '{include: .}' 12 | jq -cr '.include |= map({ openvox_release: .openvox_release, rubygem_openvox: .rubygem_openvox })' build_versions.json 13 | fi 14 | 15 | rm build_platforms.json 16 | rm build_versions.json 17 | -------------------------------------------------------------------------------- /Rakefile: -------------------------------------------------------------------------------- 1 | # frozen_string_literal: true 2 | 3 | # Managed by modulesync - DO NOT EDIT 4 | # https://voxpupuli.org/docs/updating-files-managed-with-modulesync/ 5 | 6 | begin 7 | require 'rubygems' 8 | require 'github_changelog_generator/task' 9 | rescue LoadError 10 | # github_changelog_generator isn't available, so we won't define a rake task with it 11 | else 12 | GitHubChangelogGenerator::RakeTask.new :changelog do |config| 13 | config.header = "# Changelog\n\nAll notable changes to this project will be documented in this file." 14 | config.exclude_labels = %w[duplicate question invalid wontfix wont-fix skip-changelog modulesync github_actions] 15 | config.user = 'voxpupuli' 16 | config.project = 'container-voxbox' 17 | # get branch name from git and strip off any prefixes (e.g. 'release-') 18 | config.future_release = `git rev-parse --abbrev-ref HEAD`.strip.split('-', 2).last 19 | end 20 | end 21 | -------------------------------------------------------------------------------- /.github/release.yml: -------------------------------------------------------------------------------- 1 | --- 2 | # Managed by modulesync - DO NOT EDIT 3 | # https://voxpupuli.org/docs/updating-files-managed-with-modulesync/ 4 | 5 | # https://docs.github.com/en/repositories/releasing-projects-on-github/automatically-generated-release-notes 6 | 7 | changelog: 8 | exclude: 9 | labels: 10 | - duplicate 11 | - invalid 12 | - modulesync 13 | - question 14 | - skip-changelog 15 | - wont-fix 16 | - wontfix 17 | - github_actions 18 | 19 | categories: 20 | - title: Breaking Changes 🛠 21 | labels: 22 | - backwards-incompatible 23 | 24 | - title: New Features 🎉 25 | labels: 26 | - enhancement 27 | 28 | - title: Bug Fixes 🐛 29 | labels: 30 | - bug 31 | 32 | - title: Documentation Updates 📚 33 | labels: 34 | - documentation 35 | - docs 36 | 37 | - title: Dependency Updates ⬆️ 38 | labels: 39 | - dependencies 40 | 41 | - title: Other Changes 42 | labels: 43 | - "*" 44 | -------------------------------------------------------------------------------- /voxbox/Rakefile: -------------------------------------------------------------------------------- 1 | require 'voxpupuli/test/rake' 2 | require 'voxpupuli/acceptance/rake' 3 | require 'voxpupuli/release/rake_tasks' 4 | require 'ra10ke' 5 | require 'onceover/rake_tasks' 6 | 7 | Ra10ke::RakeTask.new 8 | 9 | namespace :voxpupuli do 10 | namespace :custom do 11 | desc 'Lint with all puppet-lint checks' 12 | task :lint_all do 13 | # re-enable by puppetlabs disabled checks from puppetlabs/spec_helper 14 | # see: https://github.com/puppetlabs/puppetlabs_spec_helper/blob/70de49db0a242f83e9ff39ea8a03c830339f8368/lib/puppetlabs_spec_helper/rake_tasks.rb#L169-L177 15 | puppet_lint_enable_checks = %w[ 16 | 140chars 17 | class_inherits_from_params_class 18 | class_parameter_defaults 19 | autoloader_layout 20 | documentation 21 | single_quote_string_with_variables 22 | ] 23 | 24 | puppet_lint_enable_checks.each do |check| 25 | PuppetLint.configuration.send(:"enable_#{check}") 26 | end 27 | 28 | Rake::Task[:lint].invoke 29 | end 30 | end 31 | end 32 | -------------------------------------------------------------------------------- /.github/workflows/shellcheck.yml: -------------------------------------------------------------------------------- 1 | --- 2 | # Managed by modulesync - DO NOT EDIT 3 | # https://voxpupuli.org/docs/updating-files-managed-with-modulesync/ 4 | 5 | name: 🚦 CI / Shell Check 6 | 7 | on: 8 | pull_request: 9 | branches: 10 | - main 11 | workflow_dispatch: 12 | 13 | permissions: 14 | contents: read 15 | 16 | jobs: 17 | shellcheck: 18 | name: 'Shell Check' 19 | runs-on: ubuntu-latest 20 | permissions: 21 | security-events: write 22 | actions: read 23 | steps: 24 | - name: Repository checkout 25 | uses: actions/checkout@v6 26 | with: 27 | # Differential ShellCheck requires full git history 28 | fetch-depth: 0 29 | 30 | - id: ShellCheck 31 | name: Differential ShellCheck 32 | uses: redhat-plumbers-in-action/differential-shellcheck@v5 33 | with: 34 | scan-directory: '.' 35 | 36 | - if: always() 37 | name: Upload artifact with ShellCheck defects in SARIF format 38 | uses: actions/upload-artifact@v6 39 | with: 40 | name: Differential ShellCheck SARIF 41 | path: ${{ steps.ShellCheck.outputs.sarif }} 42 | -------------------------------------------------------------------------------- /RELEASE.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | # Release 4 | 5 | ## On a fork 6 | 7 | Please follow these instructions carefully. 8 | Ensure that you name the branch precisely as `release-vX.Y.Z` 9 | since this nomenclature is crucial for obtaining the `future_version` in the changelog. 10 | Your attention to this specific branch naming convention is essential for accurate version tracking in the changelog. 11 | 12 | ```shell 13 | export RELEASE_VERSION="X.Y.Z" 14 | git switch main 15 | git pull --rebase 16 | git switch -c release-v$RELEASE_VERSION 17 | 18 | bundle config set --local path vendor/bundle 19 | bundle config set --local with 'release' 20 | bundle install 21 | 22 | CHANGELOG_GITHUB_TOKEN="token_MC_tokenface" bundle exec rake changelog 23 | 24 | git commit --all --message "Release v${RELEASE_VERSION}" 25 | git push --set-upstream origin HEAD 26 | ``` 27 | 28 | Then open a PR, discuss and merge. 29 | 30 | ## After the merge, as a maintainer on upstream 31 | 32 | ```shell 33 | git switch main 34 | git pull --rebase 35 | git tag v$RELEASE_VERSION -m "v$RELEASE_VERSION" 36 | git push --tags 37 | ``` 38 | -------------------------------------------------------------------------------- /renovate.json: -------------------------------------------------------------------------------- 1 | { 2 | "$schema": "https://docs.renovatebot.com/renovate-schema.json", 3 | "addLabels": [ "dependencies", "renovate" ], 4 | "assigneesFromCodeOwners": true, 5 | "automerge": true, 6 | "automergeType": "pr", 7 | "customManagers": [ 8 | { 9 | "customType": "regex", 10 | "datasourceTemplate": "rubygems", 11 | "managerFilePatterns": [ 12 | "/build_versions.yaml/" 13 | ], 14 | "matchStrings": [ 15 | "rubygem_(?[a-z0-9_-]+):\\s+'(?\\d+\\.\\d+\\.\\d+)'" 16 | ] 17 | }, 18 | { 19 | "customType": "regex", 20 | "datasourceTemplate": "deb", 21 | "managerFilePatterns": [ 22 | "/build_versions.yaml/" 23 | ], 24 | "matchStrings": [ 25 | "#\\s*renovate:\\s*depName=(?.*?)\\s*openVoxRelease=(?\\d+)\\s*\\n\\s*(?\\w+_version):\\s*\"(?.*?)\"" 26 | ], 27 | "registryUrlTemplate": "https://apt.voxpupuli.org?suite=ubuntu24.04&components=openvox{{openVoxRelease}}&binaryArch=amd64" 28 | } 29 | ], 30 | "extends": [ "config:recommended", ":prImmediately" ], 31 | "vulnerabilityAlerts": { 32 | "addLabels": [ "security" ], 33 | "enabled": true 34 | }, 35 | "packageRules": [ 36 | { 37 | "matchPackagePatterns": [".*"], 38 | "dependencyDashboardApproval": false 39 | } 40 | ] 41 | } 42 | -------------------------------------------------------------------------------- /voxbox/Gemfile: -------------------------------------------------------------------------------- 1 | # frozen_string_literal: true 2 | 3 | source ENV['GEM_SOURCE'] || 'https://rubygems.org' 4 | 5 | gem 'hiera-eyaml', ENV['RUBYGEM_HIERA_EYAML'] 6 | gem 'librarian-puppet', ENV['RUBYGEM_LIBRARIAN_PUPPET'] 7 | gem 'modulesync', ENV['RUBYGEM_MODULESYNC'] 8 | gem 'onceover', ENV['RUBYGEM_ONCEOVER'] 9 | gem 'openfact', ENV['RUBYGEM_OPENFACT'] 10 | gem 'openvox', ENV['RUBYGEM_OPENVOX'] 11 | gem 'puppet_metadata', ENV['RUBYGEM_PUPPET_METADATA'] 12 | gem 'puppet-ghostbuster', ENV['RUBYGEM_PUPPET_GHOSTBUSTER'] 13 | gem 'r10k', ENV['RUBYGEM_R10K'] 14 | gem 'ra10ke', ENV['RUBYGEM_RA10KE'] 15 | gem 'rspec_junit_formatter', ENV['RUBYGEM_RSPEC_JUNIT_FORMATTER'] 16 | gem 'rubocop-performance', ENV['RUBYGEM_RUBOCOP_PERFORMANCE'] 17 | gem 'voxpupuli-acceptance', ENV['RUBYGEM_VOXPUPULI_ACCEPTANCE'] 18 | gem 'voxpupuli-release', ENV['RUBYGEM_VOXPUPULI_RELEASE'] 19 | gem 'voxpupuli-test', ENV['RUBYGEM_VOXPUPULI_TEST'] 20 | gem 'webmock', ENV['RUBYGEM_WEBMOCK'] 21 | 22 | # CVE fixes 23 | gem 'cgi', '~> 0.5' # cgi 0.1.0 has CVEs - remove default and install upstream replacement 24 | gem 'csv', '~> 3.2' # csv 3.1.2 has CVEs - remove default and install upstream replacement 25 | gem 'drb', '~> 2.2' # drb 2.1.1 has CVEs - remove default and install upstream replacement 26 | gem 'minitest', '~> 6.0' # minitest 5.16.3 has CVEs - remove default and install upstream replacement 27 | gem 'racc', '~> 1.8' # racc 1.6.2 has CVEs - remove default and install upstream replacement 28 | gem 'rdoc', '~> 7.0' # rdoc 6.2.1 has CVEs - remove default and install upstream replacement 29 | gem 'rexml', '~> 3.4' # rexml < 3.3 has CVEs - remove default and install upstream replacement 30 | gem 'stringio', '~> 3.1' # stringio 0.1.0 has CVEs - remove default and install upstream replacement 31 | 32 | # GEM fixes 33 | # removed default gems, install upstream replacements 34 | gem 'bigdecimal', '~> 4.0.0' 35 | gem 'base64', '~> 0.3.0' 36 | -------------------------------------------------------------------------------- /.github/workflows/security_scanning.yml: -------------------------------------------------------------------------------- 1 | --- 2 | name: Security Scanning 🕵️ 3 | 4 | on: 5 | push: 6 | branches: 7 | - main 8 | pull_request: 9 | branches: 10 | - main 11 | 12 | jobs: 13 | setup-matrix: 14 | runs-on: ubuntu-latest 15 | outputs: 16 | build_matrix: ${{ steps.set-build-matrix.outputs.build_matrix }} 17 | steps: 18 | - name: Source checkout 19 | uses: actions/checkout@v6 20 | 21 | - name: 'Setup yq' 22 | uses: dcarbone/install-yq-action@v1.3.1 23 | 24 | - id: set-build-matrix 25 | run: echo "build_matrix=$(bash matrix.sh build)" >> $GITHUB_OUTPUT 26 | 27 | scan_ci_container: 28 | name: 'Scan CI container' 29 | runs-on: ${{ matrix.runner }} 30 | permissions: 31 | actions: read 32 | contents: read 33 | security-events: write 34 | needs: setup-matrix 35 | strategy: 36 | matrix: ${{ fromJson(needs.setup-matrix.outputs.build_matrix) }} 37 | steps: 38 | - name: Checkout repository 39 | uses: actions/checkout@v6 40 | 41 | - name: Build CI container 42 | uses: docker/build-push-action@v6 43 | with: 44 | tags: 'ci/voxbox:${{ matrix.rubygem_openvox }}' 45 | push: false 46 | file: Containerfile 47 | platforms: linux/${{ matrix.platform }} 48 | build-args: | 49 | BASE_IMAGE=${{ matrix.base_image }} 50 | RUBYGEM_HIERA_EYAML=${{ matrix.rubygem_hiera-eyaml }} 51 | RUBYGEM_LIBRARIAN_PUPPET=${{ matrix.rubygem_librarian-puppet }} 52 | RUBYGEM_BUNDLER=${{ matrix.rubygem_bundler }} 53 | RUBYGEM_MODULESYNC=${{ matrix.rubygem_modulesync }} 54 | RUBYGEM_ONCEOVER=${{ matrix.rubygem_onceover }} 55 | RUBYGEM_OPENFACT=${{ matrix.rubygem_openfact }} 56 | RUBYGEM_OPENVOX=${{ matrix.rubygem_openvox }} 57 | RUBYGEM_PUPPET_GHOSTBUSTER=${{ matrix.rubygem_puppet-ghostbuster }} 58 | RUBYGEM_PUPPET_METADATA=${{ matrix.rubygem_puppet_metadata }} 59 | RUBYGEM_R10K=${{ matrix.rubygem_r10k }} 60 | RUBYGEM_RA10KE=${{ matrix.rubygem_ra10ke }} 61 | RUBYGEM_RSPEC_JUNIT_FORMATTER=${{ matrix.rubygem_rspec_junit_formatter }} 62 | RUBYGEM_RUBOCOP_PERFORMANCE=${{ matrix.rubygem_rubocop-performance }} 63 | RUBYGEM_VOXPUPULI_ACCEPTANCE=${{ matrix.rubygem_voxpupuli-acceptance }} 64 | RUBYGEM_VOXPUPULI_RELEASE=${{ matrix.rubygem_voxpupuli-release }} 65 | RUBYGEM_VOXPUPULI_TEST=${{ matrix.rubygem_voxpupuli-test }} 66 | RUBYGEM_WEBMOCK=${{ matrix.rubygem_webmock }} 67 | 68 | - name: Scan image with Anchore Grype 69 | uses: anchore/scan-action@v7 70 | id: scan 71 | with: 72 | image: 'ci/voxbox:${{ matrix.rubygem_openvox }}' 73 | fail-build: false 74 | 75 | - name: Inspect action SARIF report 76 | run: jq . ${{ steps.scan.outputs.sarif }} 77 | 78 | - name: Upload Anchore scan SARIF report 79 | uses: github/codeql-action/upload-sarif@v4 80 | with: 81 | sarif_file: ${{ steps.scan.outputs.sarif }} 82 | -------------------------------------------------------------------------------- /.gitlab-ci.yml: -------------------------------------------------------------------------------- 1 | --- 2 | # Example of a CI/CD pipeline for a Puppet module 3 | # Pipeline runs on main and merge_requests, but not on tags. 4 | # 5 | stages: 6 | - 🚦 QA 7 | - 🚥 Test 8 | 9 | variables: 10 | # Use internal default Rakefile, to make sure we have a working version 11 | RAKE: rake -f /Rakefile 12 | 13 | default: 14 | image: 15 | name: ghcr.io/voxpupuli/voxbox:8 16 | entrypoint: [""] 17 | 18 | ### Templates ################################################################# 19 | .default_rules: 20 | rules: 21 | - &puppetfile 22 | if: '$CI_COMMIT_TAG == null' 23 | exists: 24 | - 'Puppetfile' 25 | changes: 26 | - 'Puppetfile' 27 | 28 | ### 🚦 QA ###################################################################### 29 | .qa: 30 | stage: 🚦 QA 31 | 32 | qa-check: 33 | extends: .qa 34 | script: 35 | - $RAKE check 36 | rules: 37 | - if: '$CI_COMMIT_TAG == null' 38 | 39 | qa-lint: 40 | extends: .qa 41 | script: 42 | - $RAKE voxpupuli:custom:lint_all 43 | rules: 44 | - if: '$CI_COMMIT_TAG == null' 45 | changes: 46 | - '**/*.pp' 47 | 48 | qa-yamllint: 49 | extends: .qa 50 | script: 51 | - yamllint data/ 52 | rules: 53 | - if: '$CI_COMMIT_TAG == null' 54 | changes: 55 | - 'data/**/*.yaml' 56 | 57 | qa-metadata_lint: 58 | extends: .qa 59 | script: 60 | - $RAKE metadata_lint 61 | rules: 62 | - if: '$CI_COMMIT_TAG == null' 63 | changes: 64 | - metadata.json 65 | 66 | qa-rubocop: 67 | extends: .qa 68 | script: 69 | - $RAKE rubocop 70 | rules: 71 | - if: '$CI_COMMIT_TAG == null' 72 | changes: 73 | - '**/*.rb' 74 | 75 | qa-strings: 76 | extends: .qa 77 | script: 78 | - $RAKE strings:validate:reference 79 | rules: 80 | - if: '$CI_COMMIT_TAG == null' 81 | exists: 82 | - REFERENCE.md 83 | 84 | qa-syntax: 85 | extends: .qa 86 | script: 87 | - $RAKE syntax 88 | rules: 89 | - if: '$CI_COMMIT_TAG == null' 90 | changes: 91 | - 'data/**/*.yaml' 92 | - 'manifests/**/*.pp' 93 | - 'plans/**/*.pp' 94 | - 'templates/**/*.epp' 95 | - 'templates/**/*.erb' 96 | 97 | qa-r10k-syntax: 98 | extends: .qa 99 | script: 100 | - $RAKE r10k:syntax 101 | rules: 102 | - *puppetfile 103 | 104 | qa-r10k-duplicates: 105 | extends: .qa 106 | script: 107 | - $RAKE r10k:duplicates 108 | rules: 109 | - *puppetfile 110 | 111 | qa-r10k-validate: 112 | extends: .qa 113 | script: 114 | - $RAKE r10k:validate 115 | rules: 116 | - *puppetfile 117 | 118 | ### 🚥 Test #################################################################### 119 | .test: 120 | stage: 🚥 Test 121 | 122 | test-unit: 123 | extends: .test 124 | script: 125 | - $RAKE spec 126 | rules: 127 | - if: '$CI_COMMIT_TAG == null' 128 | changes: 129 | - 'data/**/*.yaml' 130 | - 'manifests/**/*.pp' 131 | - 'plans/**/*.pp' 132 | - 'spec/**/*_spec.rb' 133 | - 'templates/**/*.epp' 134 | - 'templates/**/*.erb' 135 | 136 | test-r10k-install: 137 | extends: .test 138 | script: 139 | - $RAKE r10k:install 140 | rules: 141 | - *puppetfile 142 | 143 | test-acceptance: 144 | extends: .test 145 | script: 146 | - $RAKE beaker 147 | rules: 148 | - if: '$CI_COMMIT_TAG == null' 149 | changes: 150 | - 'data/**/*.yaml' 151 | - 'manifests/**/*.pp' 152 | - 'plans/**/*.pp' 153 | - 'spec/**/*_spec.rb' 154 | - 'templates/**/*.epp' 155 | - 'templates/**/*.erb' 156 | -------------------------------------------------------------------------------- /evb: -------------------------------------------------------------------------------- 1 | #!/bin/bash 2 | set -e 3 | 4 | get_path () { 5 | # calculates the 'root' path to run the container 6 | if [ "${1}" == '' ] ; then 7 | echo "ERROR: ensure you start this script either in a openvox control or a module directory" >&2 8 | exit 200 9 | elif [ -f "${1}/metadata.json" ] || [ -f "${1}/Puppetfile" ] ; then 10 | echo $1 11 | else 12 | get_path $(echo $1|sed 's|/[^/]*$||') 13 | fi 14 | } 15 | 16 | usage() { 17 | # print usage of this script and exit 18 | cat << EOF 19 | Usage: ${0} [options] [command] 20 | 21 | available options: 22 | --noop : print the command to run, but do not run it 23 | --entrypoint : use a different entrypoint 24 | examples for available endpoints are: 25 | onceover, ash, puppet, yamllint, jq, curl, rubocop 26 | default: no entrypoint specified 27 | --image image : use a different image (default ${PODIMAGE}) 28 | --env VAR=val : specify environment variables (can be used multiple times) 29 | Remark: the term './' in a assignment will be replaced with 30 | the correct path to be used in the container. 31 | Example: if you start the script in ~/openvox-supermodule/spec/classes 32 | and set --env SPEC=./supermodule_spec.rb we will 33 | run VoxBox with -e SPEC=spec/classes/supermodule_spec.rb 34 | --volume vol : specify an additional volume to put into the container 35 | see podman man page how to specify 'vol'. (no path magic is done ;)) 36 | --runcmd : this lets you change the program used to start the container 37 | if not set explicit it looks for podman or docker. 38 | 39 | available command: 40 | help : print this help message and exit 41 | 42 | commands/options not listed here are passed to VoxBox as is. 43 | use the '--noop' option to print the detailed call to VoxBox. 44 | EOF 45 | exit 46 | } 47 | 48 | run_container () { 49 | P=$(get_path $PWD) 50 | command="${RUNCMD} run -it --rm $(sed "s|=${P}/|=|g" <<< "${PODENV}") -v ${P}:/repo:Z ${PODOPTIONS} ${PODIMAGE} ${VOXBOXCOMMAND}" 51 | if [ ${NOOP} -eq 0 ] ; then 52 | ${command} 53 | else 54 | echo command to run: 55 | echo ${command} 56 | echo 57 | fi 58 | } 59 | 60 | 61 | # get options 62 | NOOP=0 63 | PODOPTIONS='' 64 | PODENV='' 65 | PODIMAGE='ghcr.io/voxpupuli/voxbox:8' 66 | VOXBOXCOMMAND='' 67 | while [[ $# -gt 0 ]]; do 68 | key="$1" 69 | case $key in 70 | help) 71 | usage 72 | ;; 73 | --noop) 74 | NOOP=1 75 | shift 76 | ;; 77 | --runcmd) 78 | shift 79 | RUNCMD=${1} 80 | shift 81 | ;; 82 | --entrypoint) 83 | shift 84 | PODOPTIONS="--entrypoint ${1} ${PODOPTIONS}" 85 | shift 86 | ;; 87 | --image) 88 | shift 89 | PODIMAGE=$1 90 | shift 91 | ;; 92 | --volume) 93 | shift 94 | PODOPTIONS="-v ${1} ${PODOPTIONS}" 95 | shift 96 | ;; 97 | --env) 98 | shift 99 | PODENV="-e $(sed "s|=./|=${PWD}/|" <<< "${1}") ${PODENV}" 100 | shift 101 | ;; 102 | *) 103 | VOXBOXCOMMAND="${VOXBOXCOMMAND} ${key}" 104 | shift 105 | ;; 106 | esac 107 | done 108 | 109 | # lets see what we have as default runcmd: 110 | if [ -n "${RUNCMD}" ] ; then 111 | true 112 | elif command -v podman >/dev/null 2>&1 ; then 113 | RUNCMD='podman' 114 | elif command -v docker >/dev/null 2>&1 ; then 115 | RUNCMD='docker' 116 | else 117 | echo "ERROR: could not find podman or docker to start container" >&2 118 | exit 200 119 | fi 120 | 121 | run_container 122 | -------------------------------------------------------------------------------- /Containerfile: -------------------------------------------------------------------------------- 1 | ARG BASE_IMAGE=docker.io/ruby:3.2-alpine 2 | 3 | FROM $BASE_IMAGE AS builder 4 | 5 | # Gems have to be ARG and ENV because they are used as reference in the Gemfile 6 | ARG RUBYGEM_BUNDLER 7 | ARG RUBYGEM_HIERA_EYAML 8 | ARG RUBYGEM_LIBRARIAN_PUPPET 9 | ARG RUBYGEM_MODULESYNC 10 | ARG RUBYGEM_ONCEOVER 11 | ARG RUBYGEM_OPENFACT 12 | ARG RUBYGEM_OPENVOX 13 | ARG RUBYGEM_PUPPET_GHOSTBUSTER 14 | ARG RUBYGEM_PUPPET_METADATA 15 | ARG RUBYGEM_R10K 16 | ARG RUBYGEM_RA10KE 17 | ARG RUBYGEM_RSPEC_JUNIT_FORMATTER 18 | ARG RUBYGEM_RUBOCOP_PERFORMANCE 19 | ARG RUBYGEM_VOXPUPULI_ACCEPTANCE 20 | ARG RUBYGEM_VOXPUPULI_RELEASE 21 | ARG RUBYGEM_VOXPUPULI_TEST 22 | ARG RUBYGEM_WEBMOCK 23 | 24 | ENV RUBYGEM_BUNDLER=${RUBYGEM_BUNDLER:-2.7.2} 25 | ENV RUBYGEM_HIERA_EYAML=${RUBYGEM_HIERA_EYAML:-4.3.0} 26 | ENV RUBYGEM_LIBRARIAN_PUPPET=${RUBYGEM_LIBRARIAN_PUPPET:-6.0.0} 27 | ENV RUBYGEM_MODULESYNC=${RUBYGEM_MODULESYNC:-4.2.0} 28 | ENV RUBYGEM_ONCEOVER=${RUBYGEM_ONCEOVER:-5.0.2} 29 | ENV RUBYGEM_OPENFACT=${RUBYGEM_OPENFACT:-5.1.0} 30 | ENV RUBYGEM_OPENVOX=${RUBYGEM_OPENVOX:-8.23.1} 31 | ENV RUBYGEM_PUPPET_GHOSTBUSTER=${RUBYGEM_PUPPET_GHOSTBUSTER:-2.0.0} 32 | ENV RUBYGEM_PUPPET_METADATA=${RUBYGEM_PUPPET_METADATA:-5.3.0} 33 | ENV RUBYGEM_R10K=${RUBYGEM_R10K:-5.0.2} 34 | ENV RUBYGEM_RA10KE=${RUBYGEM_RA10KE:-4.5.0} 35 | ENV RUBYGEM_RSPEC_JUNIT_FORMATTER=${RUBYGEM_RSPEC_JUNIT_FORMATTER:-0.6.0} 36 | ENV RUBYGEM_RUBOCOP_PERFORMANCE=${RUBYGEM_RUBOCOP_PERFORMANCE:-1.23.0} 37 | ENV RUBYGEM_VOXPUPULI_ACCEPTANCE=${RUBYGEM_VOXPUPULI_ACCEPTANCE:-4.1.0} 38 | ENV RUBYGEM_VOXPUPULI_RELEASE=${RUBYGEM_VOXPUPULI_RELEASE:-5.0.1} 39 | ENV RUBYGEM_VOXPUPULI_TEST=${RUBYGEM_VOXPUPULI_TEST:-13.1.0} 40 | ENV RUBYGEM_WEBMOCK=${RUBYGEM_WEBMOCK:-3.26.1} 41 | 42 | COPY voxbox/Gemfile / 43 | 44 | RUN apk update \ 45 | && apk upgrade \ 46 | && apk add --no-cache --update alpine-sdk yaml-dev \ 47 | && rm -rf /usr/local/lib/ruby/gems/*/gems/bundler-* \ 48 | && rm -rf /usr/local/lib/ruby/gems/*/specifications/default/bundler-*.gemspec \ 49 | && gem install bundler -v ${RUBYGEM_BUNDLER} \ 50 | && bundle config set path.system true \ 51 | && bundle config set jobs $(nproc) \ 52 | && bundle install --gemfile=/Gemfile \ 53 | && bundle clean --force \ 54 | && rm -rf /usr/local/lib/ruby/gems/*/cache/* \ 55 | && rm -rf /usr/local/lib/ruby/gems/*/gems/cgi-* \ 56 | && rm -rf /usr/local/lib/ruby/gems/*/specifications/default/cgi-*.gemspec \ 57 | && rm -rf /usr/local/lib/ruby/gems/*/gems/stringio-* \ 58 | && rm -rf /usr/local/lib/ruby/gems/*/specifications/default/stringio-*.gemspec \ 59 | && rm -rf /usr/local/lib/ruby/gems/*/gems/rdoc-* \ 60 | && rm -rf /usr/local/lib/ruby/gems/*/specifications/default/rdoc-*.gemspec \ 61 | && rm -rf /usr/local/lib/ruby/gems/*/gems/rexml-* \ 62 | && rm -rf /usr/local/lib/ruby/gems/*/specifications/rexml-*.gemspec \ 63 | && rm -rf /usr/local/lib/ruby/gems/*/gems/racc-* \ 64 | && rm -rf /usr/local/lib/ruby/gems/*/specifications/default/racc-*.gemspec \ 65 | && rm -rf /usr/local/lib/ruby/gems/*/gems/drb-* \ 66 | && rm -rf /usr/local/lib/ruby/gems/*/specifications/default/drb-*.gemspec \ 67 | && rm -rf /usr/local/lib/ruby/gems/*/gems/csv-* \ 68 | && rm -rf /usr/local/lib/ruby/gems/*/specifications/default/csv-*.gemspec \ 69 | && rm -rf /usr/local/lib/ruby/gems/*/gems/minitest-* \ 70 | && rm -rf /usr/local/lib/ruby/gems/*/specifications/minitest-*.gemspec \ 71 | && rm -rf /usr/local/lib/ruby/gems/*/gems/base64-* \ 72 | && rm -rf /usr/local/lib/ruby/gems/*/specifications/default/base64-*.gemspec \ 73 | && rm -rf /usr/local/lib/ruby/gems/*/gems/bigdecimal-* \ 74 | && rm -rf /usr/local/lib/ruby/gems/*/specifications/default/bigdecimal-*.gemspec 75 | 76 | ############################################################################### 77 | 78 | FROM $BASE_IMAGE AS final 79 | 80 | LABEL org.label-schema.maintainer="Voxpupuli Team " \ 81 | org.label-schema.vendor="Voxpupuli" \ 82 | org.label-schema.url="https://github.com/voxpupuli/container-voxbox" \ 83 | org.label-schema.name="Vox Pupuli Test Box" \ 84 | org.label-schema.license="AGPL-3.0-or-later" \ 85 | org.label-schema.vcs-url="https://github.com/voxpupuli/container-voxbox" \ 86 | org.label-schema.schema-version="1.0" \ 87 | org.label-schema.dockerfile="/Containerfile" 88 | 89 | # Disable warnings for experimental features 90 | ENV RUBYOPT="-W:no-experimental" 91 | 92 | RUN apk update \ 93 | && apk upgrade \ 94 | && apk add --no-cache openssh-client \ 95 | && apk add --no-cache gpg \ 96 | && apk add --no-cache jq \ 97 | && apk add --no-cache yamllint \ 98 | && apk add --no-cache git \ 99 | && apk add --no-cache curl \ 100 | && rm -rf /usr/local/lib/ruby/gems 101 | 102 | COPY --from=builder /usr/local/lib/ruby/gems /usr/local/lib/ruby/gems 103 | COPY --from=builder /usr/local/bundle /usr/local/bundle 104 | COPY --from=builder /Gemfile.lock /Gemfile.lock 105 | COPY Containerfile / 106 | COPY voxbox/Rakefile / 107 | COPY voxbox/Gemfile / 108 | 109 | WORKDIR /repo 110 | 111 | ENTRYPOINT [ "rake", "-f", "/Rakefile" ] 112 | CMD [ "-T" ] 113 | -------------------------------------------------------------------------------- /.github/workflows/ci.yaml: -------------------------------------------------------------------------------- 1 | --- 2 | name: 🚦 CI 3 | 4 | on: 5 | pull_request: 6 | branches: 7 | - main 8 | workflow_dispatch: 9 | 10 | permissions: 11 | contents: read 12 | 13 | jobs: 14 | setup-matrix: 15 | runs-on: ubuntu-latest 16 | outputs: 17 | build_matrix: ${{ steps.set-build-matrix.outputs.build_matrix }} 18 | steps: 19 | - name: Source checkout 20 | uses: actions/checkout@v6 21 | 22 | - name: 'Setup yq' 23 | uses: dcarbone/install-yq-action@v1.3.1 24 | 25 | - id: set-build-matrix 26 | run: echo "build_matrix=$(bash matrix.sh build)" >> $GITHUB_OUTPUT 27 | 28 | build_ci_container: 29 | name: Build ${{ matrix.platform }} CI container 30 | runs-on: ${{ matrix.runner }} 31 | permissions: 32 | actions: read 33 | contents: read 34 | security-events: write 35 | pull-requests: write 36 | needs: setup-matrix 37 | strategy: 38 | matrix: ${{ fromJson(needs.setup-matrix.outputs.build_matrix) }} 39 | steps: 40 | - name: Checkout repository 41 | uses: actions/checkout@v6 42 | 43 | - name: Build image 44 | uses: docker/build-push-action@v6 45 | with: 46 | file: Containerfile 47 | tags: 'ci/voxbox:${{ matrix.rubygem_openvox }}' 48 | push: false 49 | platforms: linux/${{ matrix.platform }} 50 | build-args: | 51 | BASE_IMAGE=${{ matrix.base_image }} 52 | RUBYGEM_BUNDLER=${{ matrix.rubygem_bundler }} 53 | RUBYGEM_HIERA_EYAML=${{ matrix.rubygem_hiera-eyaml }} 54 | RUBYGEM_LIBRARIAN_PUPPET=${{ matrix.rubygem_librarian-puppet }} 55 | RUBYGEM_MODULESYNC=${{ matrix.rubygem_modulesync }} 56 | RUBYGEM_ONCEOVER=${{ matrix.rubygem_onceover }} 57 | RUBYGEM_OPENFACT=${{ matrix.rubygem_openfact }} 58 | RUBYGEM_OPENVOX=${{ matrix.rubygem_openvox }} 59 | RUBYGEM_PUPPET_GHOSTBUSTER=${{ matrix.rubygem_puppet-ghostbuster }} 60 | RUBYGEM_PUPPET_METADATA=${{ matrix.rubygem_puppet_metadata }} 61 | RUBYGEM_R10K=${{ matrix.rubygem_r10k }} 62 | RUBYGEM_RA10KE=${{ matrix.rubygem_ra10ke }} 63 | RUBYGEM_RSPEC_JUNIT_FORMATTER=${{ matrix.rubygem_rspec_junit_formatter }} 64 | RUBYGEM_RUBOCOP_PERFORMANCE=${{ matrix.rubygem_rubocop-performance }} 65 | RUBYGEM_VOXPUPULI_ACCEPTANCE=${{ matrix.rubygem_voxpupuli-acceptance }} 66 | RUBYGEM_VOXPUPULI_RELEASE=${{ matrix.rubygem_voxpupuli-release }} 67 | RUBYGEM_VOXPUPULI_TEST=${{ matrix.rubygem_voxpupuli-test }} 68 | RUBYGEM_WEBMOCK=${{ matrix.rubygem_webmock }} 69 | 70 | - name: Clone voxpupuli/puppet-example repository 71 | uses: actions/checkout@v6 72 | with: 73 | repository: voxpupuli/puppet-example 74 | 75 | - name: Test container 76 | run: | 77 | docker run --rm -v $PWD:/repo:Z ci/voxbox:${{ matrix.rubygem_openvox }} -f /Rakefile -T 78 | docker run --rm -v $PWD:/repo:Z ci/voxbox:${{ matrix.rubygem_openvox }} -f /Rakefile lint 79 | docker run --rm -v $PWD:/repo:Z ci/voxbox:${{ matrix.rubygem_openvox }} -f /Rakefile metadata_lint 80 | docker run --rm -v $PWD:/repo:Z ci/voxbox:${{ matrix.rubygem_openvox }} -f /Rakefile r10k:dependencies 81 | docker run --rm -v $PWD:/repo:Z ci/voxbox:${{ matrix.rubygem_openvox }} -f /Rakefile r10k:syntax 82 | docker run --rm -v $PWD:/repo:Z ci/voxbox:${{ matrix.rubygem_openvox }} -f /Rakefile rubocop 83 | docker run --rm -v $PWD:/repo:Z ci/voxbox:${{ matrix.rubygem_openvox }} -f /Rakefile spec 84 | docker run --rm -v $PWD:/repo:Z ci/voxbox:${{ matrix.rubygem_openvox }} -f /Rakefile strings:validate:reference 85 | docker run --rm -v $PWD:/repo:Z ci/voxbox:${{ matrix.rubygem_openvox }} -f /Rakefile syntax 86 | 87 | - name: Bundle Info 88 | run: | 89 | docker run --rm --entrypoint=ash ci/voxbox:${{ matrix.rubygem_openvox }} -c "bundle check" 90 | docker run --rm --entrypoint=ash ci/voxbox:${{ matrix.rubygem_openvox }} -c "bundle env" 91 | docker run --rm --entrypoint=ash ci/voxbox:${{ matrix.rubygem_openvox }} -c "bundle outdated || true" 92 | 93 | tests: 94 | needs: 95 | - build_ci_container 96 | runs-on: ubuntu-latest 97 | name: Test suite 98 | steps: 99 | - run: echo Test suite completed 100 | 101 | dependabot: 102 | permissions: 103 | contents: write 104 | name: 'Dependabot auto-merge' 105 | needs: 106 | - tests 107 | runs-on: ubuntu-latest 108 | if: ${{ github.actor == 'dependabot[bot]' && github.event_name == 'pull_request'}} 109 | steps: 110 | - name: Dependabot metadata 111 | id: metadata 112 | uses: dependabot/fetch-metadata@v2.4.0 113 | with: 114 | github-token: '${{ secrets.GITHUB_TOKEN }}' 115 | 116 | - name: Enable auto-merge for Dependabot PRs 117 | run: gh pr merge --auto --merge "$PR_URL" 118 | env: 119 | PR_URL: ${{github.event.pull_request.html_url}} 120 | GITHUB_TOKEN: ${{secrets.GITHUB_TOKEN}} 121 | -------------------------------------------------------------------------------- /.github/workflows/build_container.yml: -------------------------------------------------------------------------------- 1 | --- 2 | name: 📦 Build and Publish 3 | 4 | on: 5 | push: 6 | branches: 7 | - 'main' 8 | tags: 9 | - '*' 10 | workflow_dispatch: 11 | 12 | permissions: 13 | contents: read 14 | 15 | jobs: 16 | setup-matrix: 17 | runs-on: ubuntu-latest 18 | outputs: 19 | build_matrix: ${{ steps.set-build-matrix.outputs.build_matrix }} 20 | tag_matrix: ${{ steps.set-tag-matrix.outputs.tag_matrix }} 21 | steps: 22 | - name: Source checkout 23 | uses: actions/checkout@v6 24 | 25 | - name: 'Setup yq' 26 | uses: dcarbone/install-yq-action@v1.3.1 27 | 28 | - id: set-build-matrix 29 | run: echo "build_matrix=$(bash matrix.sh build)" >> $GITHUB_OUTPUT 30 | 31 | - id: set-tag-matrix 32 | run: echo "tag_matrix=$(bash matrix.sh tag)" >> $GITHUB_OUTPUT 33 | 34 | build-and-push-container: 35 | runs-on: ${{ matrix.runner }} 36 | permissions: 37 | contents: read 38 | packages: write 39 | needs: setup-matrix 40 | strategy: 41 | matrix: ${{ fromJson(needs.setup-matrix.outputs.build_matrix) }} 42 | steps: 43 | - name: Build Vox Pupuli Test Container v${{ matrix.openvox_release }}-${{ matrix.platform }} 44 | uses: voxpupuli/gha-build-and-publish-a-container@v2 45 | with: 46 | registry_password: ${{ secrets.GITHUB_TOKEN }} 47 | build_args: | 48 | BASE_IMAGE=${{ matrix.base_image }} 49 | RUBYGEM_HIERA_EYAML=${{ matrix.rubygem_hiera-eyaml }} 50 | RUBYGEM_LIBRARIAN_PUPPET=${{ matrix.rubygem_librarian-puppet }} 51 | RUBYGEM_BUNDLER=${{ matrix.rubygem_bundler }} 52 | RUBYGEM_MODULESYNC=${{ matrix.rubygem_modulesync }} 53 | RUBYGEM_ONCEOVER=${{ matrix.rubygem_onceover }} 54 | RUBYGEM_OPENFACT=${{ matrix.rubygem_openfact }} 55 | RUBYGEM_OPENVOX=${{ matrix.rubygem_openvox }} 56 | RUBYGEM_PUPPET_GHOSTBUSTER=${{ matrix.rubygem_puppet-ghostbuster }} 57 | RUBYGEM_PUPPET_METADATA=${{ matrix.rubygem_puppet_metadata }} 58 | RUBYGEM_R10K=${{ matrix.rubygem_r10k }} 59 | RUBYGEM_RA10KE=${{ matrix.rubygem_ra10ke }} 60 | RUBYGEM_RSPEC_JUNIT_FORMATTER=${{ matrix.rubygem_rspec_junit_formatter }} 61 | RUBYGEM_RUBOCOP_PERFORMANCE=${{ matrix.rubygem_rubocop-performance }} 62 | RUBYGEM_VOXPUPULI_ACCEPTANCE=${{ matrix.rubygem_voxpupuli-acceptance }} 63 | RUBYGEM_VOXPUPULI_RELEASE=${{ matrix.rubygem_voxpupuli-release }} 64 | RUBYGEM_VOXPUPULI_TEST=${{ matrix.rubygem_voxpupuli-test }} 65 | RUBYGEM_WEBMOCK=${{ matrix.rubygem_webmock }} 66 | build_arch: linux/${{ matrix.platform }} 67 | buildfile: Containerfile 68 | docker_username: voxpupulibot 69 | docker_password: ${{ secrets.DOCKERHUB_BOT_ADMIN_TOKEN }} 70 | tags: | 71 | ghcr.io/${{ github.repository_owner }}/voxbox:${{ github.sha }}-v${{ matrix.openvox_release }}-${{ matrix.platform }} 72 | 73 | create-multiarch-manifests: 74 | runs-on: ubuntu-latest 75 | permissions: 76 | contents: read 77 | packages: write 78 | needs: 79 | - setup-matrix 80 | - build-and-push-container 81 | strategy: 82 | matrix: ${{ fromJson(needs.setup-matrix.outputs.tag_matrix) }} 83 | steps: 84 | - name: Log in to the ghcr.io registry 85 | uses: docker/login-action@v3 86 | with: 87 | registry: ghcr.io 88 | username: ${{ github.repository_owner }} 89 | password: ${{ secrets.GITHUB_TOKEN }} 90 | 91 | - name: Log in to the docker.io registry 92 | uses: docker/login-action@v3 93 | with: 94 | registry: docker.io 95 | username: voxpupulibot 96 | password: ${{ secrets.DOCKERHUB_BOT_ADMIN_TOKEN }} 97 | 98 | - name: Create multiarch manifests 99 | run: | 100 | docker buildx imagetools create -t ghcr.io/${{ github.repository_owner }}/voxbox:${{ matrix.rubygem_openvox }}-${{ github.ref_name }} \ 101 | ghcr.io/${{ github.repository_owner }}/voxbox:${{ github.sha }}-v${{ matrix.openvox_release }}-arm64 \ 102 | ghcr.io/${{ github.repository_owner }}/voxbox:${{ github.sha }}-v${{ matrix.openvox_release }}-amd64 103 | 104 | docker buildx imagetools create -t ghcr.io/${{ github.repository_owner }}/voxbox:${{ matrix.rubygem_openvox }}-latest \ 105 | ghcr.io/${{ github.repository_owner }}/voxbox:${{ github.sha }}-v${{ matrix.openvox_release }}-arm64 \ 106 | ghcr.io/${{ github.repository_owner }}/voxbox:${{ github.sha }}-v${{ matrix.openvox_release }}-amd64 107 | 108 | docker buildx imagetools create -t ghcr.io/${{ github.repository_owner }}/voxbox:${{ matrix.openvox_release }}-${{ github.ref_name }} \ 109 | ghcr.io/${{ github.repository_owner }}/voxbox:${{ github.sha }}-v${{ matrix.openvox_release }}-arm64 \ 110 | ghcr.io/${{ github.repository_owner }}/voxbox:${{ github.sha }}-v${{ matrix.openvox_release }}-amd64 111 | 112 | docker buildx imagetools create -t ghcr.io/${{ github.repository_owner }}/voxbox:${{ matrix.openvox_release }} \ 113 | ghcr.io/${{ github.repository_owner }}/voxbox:${{ github.sha }}-v${{ matrix.openvox_release }}-arm64 \ 114 | ghcr.io/${{ github.repository_owner }}/voxbox:${{ github.sha }}-v${{ matrix.openvox_release }}-amd64 115 | 116 | docker buildx imagetools create -t ghcr.io/${{ github.repository_owner }}/voxbox:${{ matrix.openvox_release }}-latest \ 117 | ghcr.io/${{ github.repository_owner }}/voxbox:${{ github.sha }}-v${{ matrix.openvox_release }}-arm64 \ 118 | ghcr.io/${{ github.repository_owner }}/voxbox:${{ github.sha }}-v${{ matrix.openvox_release }}-amd64 119 | 120 | docker buildx imagetools create -t ghcr.io/${{ github.repository_owner }}/voxbox:latest \ 121 | ghcr.io/${{ github.repository_owner }}/voxbox:${{ github.sha }}-v${{ matrix.openvox_release }}-arm64 \ 122 | ghcr.io/${{ github.repository_owner }}/voxbox:${{ github.sha }}-v${{ matrix.openvox_release }}-amd64 123 | 124 | docker buildx imagetools create -t docker.io/${{ github.repository_owner }}/voxbox:${{ matrix.rubygem_openvox }}-${{ github.ref_name }} \ 125 | ghcr.io/${{ github.repository_owner }}/voxbox:${{ github.sha }}-v${{ matrix.openvox_release }}-arm64 \ 126 | ghcr.io/${{ github.repository_owner }}/voxbox:${{ github.sha }}-v${{ matrix.openvox_release }}-amd64 127 | 128 | docker buildx imagetools create -t docker.io/${{ github.repository_owner }}/voxbox:${{ matrix.rubygem_openvox }}-latest \ 129 | ghcr.io/${{ github.repository_owner }}/voxbox:${{ github.sha }}-v${{ matrix.openvox_release }}-arm64 \ 130 | ghcr.io/${{ github.repository_owner }}/voxbox:${{ github.sha }}-v${{ matrix.openvox_release }}-amd64 131 | 132 | docker buildx imagetools create -t docker.io/${{ github.repository_owner }}/voxbox:${{ matrix.openvox_release }}-${{ github.ref_name }} \ 133 | ghcr.io/${{ github.repository_owner }}/voxbox:${{ github.sha }}-v${{ matrix.openvox_release }}-arm64 \ 134 | ghcr.io/${{ github.repository_owner }}/voxbox:${{ github.sha }}-v${{ matrix.openvox_release }}-amd64 135 | 136 | docker buildx imagetools create -t docker.io/${{ github.repository_owner }}/voxbox:${{ matrix.openvox_release }} \ 137 | ghcr.io/${{ github.repository_owner }}/voxbox:${{ github.sha }}-v${{ matrix.openvox_release }}-arm64 \ 138 | ghcr.io/${{ github.repository_owner }}/voxbox:${{ github.sha }}-v${{ matrix.openvox_release }}-amd64 139 | 140 | docker buildx imagetools create -t docker.io/${{ github.repository_owner }}/voxbox:${{ matrix.openvox_release }}-latest \ 141 | ghcr.io/${{ github.repository_owner }}/voxbox:${{ github.sha }}-v${{ matrix.openvox_release }}-arm64 \ 142 | ghcr.io/${{ github.repository_owner }}/voxbox:${{ github.sha }}-v${{ matrix.openvox_release }}-amd64 143 | 144 | docker buildx imagetools create -t docker.io/${{ github.repository_owner }}/voxbox:latest \ 145 | ghcr.io/${{ github.repository_owner }}/voxbox:${{ github.sha }}-v${{ matrix.openvox_release }}-arm64 \ 146 | ghcr.io/${{ github.repository_owner }}/voxbox:${{ github.sha }}-v${{ matrix.openvox_release }}-amd64 147 | 148 | info-output: 149 | runs-on: ubuntu-latest 150 | name: Bundle Info 151 | needs: 152 | - setup-matrix 153 | - build-and-push-container 154 | strategy: 155 | matrix: ${{ fromJson(needs.setup-matrix.outputs.build_matrix) }} 156 | container: ghcr.io/voxpupuli/voxbox:${{ github.sha }}-v${{ matrix.openvox_release }}-amd64 157 | steps: 158 | - name: bundle info 159 | run: | 160 | bundle check 161 | bundle env 162 | bundle outdated || true 163 | 164 | update-dockerhub-description: 165 | runs-on: ubuntu-latest 166 | needs: 167 | - create-multiarch-manifests 168 | steps: 169 | - name: Source checkout 170 | uses: actions/checkout@v6 171 | 172 | - name: Update Docker Hub Description 173 | uses: peter-evans/dockerhub-description@v5 174 | with: 175 | username: voxpupulibot 176 | password: ${{ secrets.DOCKERHUB_BOT_ADMIN_TOKEN }} 177 | repository: voxpupuli/voxbox 178 | -------------------------------------------------------------------------------- /CHANGELOG.md: -------------------------------------------------------------------------------- 1 | # Changelog 2 | 3 | All notable changes to this project will be documented in this file. 4 | 5 | ## [v4.0.1](https://github.com/voxpupuli/container-voxbox/tree/v4.0.1) (2025-10-16) 6 | 7 | [Full Changelog](https://github.com/voxpupuli/container-voxbox/compare/v4.0.0...v4.0.1) 8 | 9 | **Fixed bugs:** 10 | 11 | - fix: repair labeler CI [\#162](https://github.com/voxpupuli/container-voxbox/pull/162) ([rwaffen](https://github.com/rwaffen)) 12 | - fix: use openvox in all CI [\#161](https://github.com/voxpupuli/container-voxbox/pull/161) ([rwaffen](https://github.com/rwaffen)) 13 | 14 | ## [v4.0.0](https://github.com/voxpupuli/container-voxbox/tree/v4.0.0) (2025-10-16) 15 | 16 | [Full Changelog](https://github.com/voxpupuli/container-voxbox/compare/v3.2.0...v4.0.0) 17 | 18 | **Implemented enhancements:** 19 | 20 | - add a script evb \(=EasyVoxBox\) for more comfortable use of VoxBox [\#136](https://github.com/voxpupuli/container-voxbox/pull/136) ([trefzer](https://github.com/trefzer)) 21 | - feat: change to openvox/openfact gem [\#119](https://github.com/voxpupuli/container-voxbox/pull/119) ([rwaffen](https://github.com/rwaffen)) 22 | 23 | **Fixed bugs:** 24 | 25 | - fix ghostbuster [\#142](https://github.com/voxpupuli/container-voxbox/pull/142) ([tuxmea](https://github.com/tuxmea)) 26 | 27 | **Merged pull requests:** 28 | 29 | - chore\(deps\): update dependency onceover to v5 [\#125](https://github.com/voxpupuli/container-voxbox/pull/125) ([renovate[bot]](https://github.com/apps/renovate)) 30 | 31 | ## [v3.2.0](https://github.com/voxpupuli/container-voxbox/tree/v3.2.0) (2025-07-11) 32 | 33 | [Full Changelog](https://github.com/voxpupuli/container-voxbox/compare/v3.1.0...v3.2.0) 34 | 35 | **Merged pull requests:** 36 | 37 | - feat: switch to Containerfile and update CI workflows to use it, update gemset to eliminate duplicates [\#128](https://github.com/voxpupuli/container-voxbox/pull/128) ([rwaffen](https://github.com/rwaffen)) 38 | - docs: add more hints for using onceover [\#121](https://github.com/voxpupuli/container-voxbox/pull/121) ([rwaffen](https://github.com/rwaffen)) 39 | 40 | ## [v3.1.0](https://github.com/voxpupuli/container-voxbox/tree/v3.1.0) (2025-05-22) 41 | 42 | [Full Changelog](https://github.com/voxpupuli/container-voxbox/compare/v3.0.0...v3.1.0) 43 | 44 | **Fixed bugs:** 45 | 46 | - codeowners are broken [\#95](https://github.com/voxpupuli/container-voxbox/issues/95) 47 | - fix: actually use specified r10k and ra10ke versions [\#114](https://github.com/voxpupuli/container-voxbox/pull/114) ([rwaffen](https://github.com/rwaffen)) 48 | - fix: resolve gem problems [\#104](https://github.com/voxpupuli/container-voxbox/pull/104) ([rwaffen](https://github.com/rwaffen)) 49 | 50 | **Closed issues:** 51 | 52 | - fix gem problems [\#97](https://github.com/voxpupuli/container-voxbox/issues/97) 53 | 54 | **Merged pull requests:** 55 | 56 | - docs: add rubocop entrypoint howto, update wording regarding OpenVox and Puppet [\#110](https://github.com/voxpupuli/container-voxbox/pull/110) ([rwaffen](https://github.com/rwaffen)) 57 | - docs: add gitlab unit test report and codequality report [\#109](https://github.com/voxpupuli/container-voxbox/pull/109) ([rwaffen](https://github.com/rwaffen)) 58 | - docs: put ghostbuster in order, update build\_versions link [\#102](https://github.com/voxpupuli/container-voxbox/pull/102) ([rwaffen](https://github.com/rwaffen)) 59 | 60 | ## [v3.0.0](https://github.com/voxpupuli/container-voxbox/tree/v3.0.0) (2025-03-14) 61 | 62 | [Full Changelog](https://github.com/voxpupuli/container-voxbox/compare/v2.3.0...v3.0.0) 63 | 64 | **Breaking changes:** 65 | 66 | - feat: deprecate voxbox:7 [\#83](https://github.com/voxpupuli/container-voxbox/pull/83) ([rwaffen](https://github.com/rwaffen)) 67 | 68 | **Implemented enhancements:** 69 | 70 | - feat: add ghostbuster [\#98](https://github.com/voxpupuli/container-voxbox/pull/98) ([rwaffen](https://github.com/rwaffen)) 71 | - chore\(deps\): update dependency ra10ke to v4 [\#92](https://github.com/voxpupuli/container-voxbox/pull/92) ([renovate[bot]](https://github.com/apps/renovate)) 72 | - chore\(deps\): update dependency r10k to v5 [\#91](https://github.com/voxpupuli/container-voxbox/pull/91) ([renovate[bot]](https://github.com/apps/renovate)) 73 | - chore\(deps\): update dependency puppet\_metadata to v4.6.0 [\#90](https://github.com/voxpupuli/container-voxbox/pull/90) ([renovate[bot]](https://github.com/apps/renovate)) 74 | - chore\(deps\): update dependency bundler to v2.6.5 [\#88](https://github.com/voxpupuli/container-voxbox/pull/88) ([renovate[bot]](https://github.com/apps/renovate)) 75 | - fix: renovate looks for the name rubygem\_\*, so fix the names [\#87](https://github.com/voxpupuli/container-voxbox/pull/87) ([rwaffen](https://github.com/rwaffen)) 76 | - feat: add renovate for rubygem updates [\#85](https://github.com/voxpupuli/container-voxbox/pull/85) ([rwaffen](https://github.com/rwaffen)) 77 | - feat: remove ffi pinning, does work again [\#84](https://github.com/voxpupuli/container-voxbox/pull/84) ([rwaffen](https://github.com/rwaffen)) 78 | - feat: add rubygem rspec\_junit\_formatter for junit output on spec tests [\#81](https://github.com/voxpupuli/container-voxbox/pull/81) ([rwaffen](https://github.com/rwaffen)) 79 | - feat: add some package to do releases [\#78](https://github.com/voxpupuli/container-voxbox/pull/78) ([lbetz](https://github.com/lbetz)) 80 | - feat: add onceover rubygem [\#72](https://github.com/voxpupuli/container-voxbox/pull/72) ([tuxmea](https://github.com/tuxmea)) 81 | - feat: unpin apk packages, remove overcommit, switch back to github runners [\#69](https://github.com/voxpupuli/container-voxbox/pull/69) ([rwaffen](https://github.com/rwaffen)) 82 | 83 | **Closed issues:** 84 | 85 | - test rubygem ffi 1.17.0 again [\#80](https://github.com/voxpupuli/container-voxbox/issues/80) 86 | - check if onceover can be implemented into voxbox [\#70](https://github.com/voxpupuli/container-voxbox/issues/70) 87 | - switch ci container build back to github runners [\#68](https://github.com/voxpupuli/container-voxbox/issues/68) 88 | 89 | **Merged pull requests:** 90 | 91 | - docs: add hint about using internal Rakefile [\#94](https://github.com/voxpupuli/container-voxbox/pull/94) ([rwaffen](https://github.com/rwaffen)) 92 | - docs: add how to run a single spec, fix markdown linter warnings [\#93](https://github.com/voxpupuli/container-voxbox/pull/93) ([rwaffen](https://github.com/rwaffen)) 93 | - docs: update tool docu, add toc, re-order sections [\#82](https://github.com/voxpupuli/container-voxbox/pull/82) ([rwaffen](https://github.com/rwaffen)) 94 | - docs: Update Readme for onceover, add onceover rake tasks [\#75](https://github.com/voxpupuli/container-voxbox/pull/75) ([tuxmea](https://github.com/tuxmea)) 95 | 96 | ## [v2.3.0](https://github.com/voxpupuli/container-voxbox/tree/v2.3.0) (2024-12-02) 97 | 98 | [Full Changelog](https://github.com/voxpupuli/container-voxbox/compare/v2.2.0...v2.3.0) 99 | 100 | **Implemented enhancements:** 101 | 102 | - feat: Update gitlab-ci example [\#66](https://github.com/voxpupuli/container-voxbox/pull/66) ([rwaffen](https://github.com/rwaffen)) 103 | - fix: LegacyKeyValueFormat and update curl patch level [\#65](https://github.com/voxpupuli/container-voxbox/pull/65) ([rwaffen](https://github.com/rwaffen)) 104 | - fix: update curl version [\#64](https://github.com/voxpupuli/container-voxbox/pull/64) ([rwaffen](https://github.com/rwaffen)) 105 | - feat: update puppet, facter, voxpupuli-test, puppet-metadata, rubocop-performance, bundler [\#59](https://github.com/voxpupuli/container-voxbox/pull/59) ([rwaffen](https://github.com/rwaffen)) 106 | - feat: do multi stage build [\#54](https://github.com/voxpupuli/container-voxbox/pull/54) ([rwaffen](https://github.com/rwaffen)) 107 | - feat: update gems to latest versions [\#52](https://github.com/voxpupuli/container-voxbox/pull/52) ([rwaffen](https://github.com/rwaffen)) 108 | 109 | **Fixed bugs:** 110 | 111 | - fix: add back curl [\#57](https://github.com/voxpupuli/container-voxbox/pull/57) ([rwaffen](https://github.com/rwaffen)) 112 | - fix: add back cve fixes for system gems [\#55](https://github.com/voxpupuli/container-voxbox/pull/55) ([rwaffen](https://github.com/rwaffen)) 113 | 114 | ## [v2.2.0](https://github.com/voxpupuli/container-voxbox/tree/v2.2.0) (2024-09-16) 115 | 116 | [Full Changelog](https://github.com/voxpupuli/container-voxbox/compare/v2.1.0...v2.2.0) 117 | 118 | **Implemented enhancements:** 119 | 120 | - feat: re-enable by puppetlabs disabled puppet-lint checks [\#48](https://github.com/voxpupuli/container-voxbox/pull/48) ([rwaffen](https://github.com/rwaffen)) 121 | - fix: update bundler, fix cve in voxbox7 [\#45](https://github.com/voxpupuli/container-voxbox/pull/45) ([rwaffen](https://github.com/rwaffen)) 122 | - fix: in ruby 2.7 rexml is a default gem [\#42](https://github.com/voxpupuli/container-voxbox/pull/42) ([rwaffen](https://github.com/rwaffen)) 123 | - Fix: update CVE infested gems [\#41](https://github.com/voxpupuli/container-voxbox/pull/41) ([rwaffen](https://github.com/rwaffen)) 124 | 125 | **Fixed bugs:** 126 | 127 | - fix: update broken facter reference in build [\#46](https://github.com/voxpupuli/container-voxbox/pull/46) ([rwaffen](https://github.com/rwaffen)) 128 | 129 | **Merged pull requests:** 130 | 131 | - doc: add info about additionally included tools [\#39](https://github.com/voxpupuli/container-voxbox/pull/39) ([rwaffen](https://github.com/rwaffen)) 132 | 133 | ## [v2.1.0](https://github.com/voxpupuli/container-voxbox/tree/v2.1.0) (2024-08-21) 134 | 135 | [Full Changelog](https://github.com/voxpupuli/container-voxbox/compare/v2.0.0...v2.1.0) 136 | 137 | **Implemented enhancements:** 138 | 139 | - Add jq for json handling in CIs [\#34](https://github.com/voxpupuli/container-voxbox/pull/34) ([rwaffen](https://github.com/rwaffen)) 140 | 141 | ## [v2.0.0](https://github.com/voxpupuli/container-voxbox/tree/v2.0.0) (2024-07-31) 142 | 143 | [Full Changelog](https://github.com/voxpupuli/container-voxbox/compare/v1.3.0...v2.0.0) 144 | 145 | **Breaking changes:** 146 | 147 | - switch to alpine [\#28](https://github.com/voxpupuli/container-voxbox/pull/28) ([rwaffen](https://github.com/rwaffen)) 148 | - update puppet, facter and voxpupuli-test to latest versions, update build defaults [\#26](https://github.com/voxpupuli/container-voxbox/pull/26) ([rwaffen](https://github.com/rwaffen)) 149 | 150 | ## [v1.3.0](https://github.com/voxpupuli/container-voxbox/tree/v1.3.0) (2024-07-09) 151 | 152 | [Full Changelog](https://github.com/voxpupuli/container-voxbox/compare/v1.2.0...v1.3.0) 153 | 154 | **Implemented enhancements:** 155 | 156 | - chore: Update rubygem versions in build\_versions.json [\#23](https://github.com/voxpupuli/container-voxbox/pull/23) ([rwaffen](https://github.com/rwaffen)) 157 | - Remove stringio 0.1.0 from ruby 2.7 and replace with 3.1 [\#22](https://github.com/voxpupuli/container-voxbox/pull/22) ([rwaffen](https://github.com/rwaffen)) 158 | 159 | ## [v1.2.0](https://github.com/voxpupuli/container-voxbox/tree/v1.2.0) (2024-06-13) 160 | 161 | [Full Changelog](https://github.com/voxpupuli/container-voxbox/compare/v1.1.0...v1.2.0) 162 | 163 | **Implemented enhancements:** 164 | 165 | - Update puppet to 7.31.0 & 8.7.0 and also update gem versions [\#16](https://github.com/voxpupuli/container-voxbox/pull/16) ([rwaffen](https://github.com/rwaffen)) 166 | - add yamllint [\#13](https://github.com/voxpupuli/container-voxbox/pull/13) ([rwaffen](https://github.com/rwaffen)) 167 | 168 | **Closed issues:** 169 | 170 | - add yamllint [\#12](https://github.com/voxpupuli/container-voxbox/issues/12) 171 | 172 | **Merged pull requests:** 173 | 174 | - Describe in more detail the entrypoint and switch from "supported" to "available" rake tasks [\#15](https://github.com/voxpupuli/container-voxbox/pull/15) ([rwaffen](https://github.com/rwaffen)) 175 | - describe in more detail how to use the voxbox [\#14](https://github.com/voxpupuli/container-voxbox/pull/14) ([rwaffen](https://github.com/rwaffen)) 176 | - Remove libs not needed with CVEs, move defaults to puppet 8 [\#11](https://github.com/voxpupuli/container-voxbox/pull/11) ([rwaffen](https://github.com/rwaffen)) 177 | 178 | ## [v1.1.0](https://github.com/voxpupuli/container-voxbox/tree/v1.1.0) (2024-04-19) 179 | 180 | [Full Changelog](https://github.com/voxpupuli/container-voxbox/compare/v1.0.0...v1.1.0) 181 | 182 | **Implemented enhancements:** 183 | 184 | - update puppet to 7.30.0 and 8.6.0, facter to 4.7.0 and r10k to 4.1.0 [\#8](https://github.com/voxpupuli/container-voxbox/pull/8) ([rwaffen](https://github.com/rwaffen)) 185 | 186 | **Merged pull requests:** 187 | 188 | - Update GitHub actions: Labeler, Add Release workflow, try to fix trivy [\#9](https://github.com/voxpupuli/container-voxbox/pull/9) ([rwaffen](https://github.com/rwaffen)) 189 | - remove artifacts from gitlab example [\#7](https://github.com/voxpupuli/container-voxbox/pull/7) ([rwaffen](https://github.com/rwaffen)) 190 | - fix wrong file name of gitlab-ci.yml [\#6](https://github.com/voxpupuli/container-voxbox/pull/6) ([rwaffen](https://github.com/rwaffen)) 191 | - update README.md to highlight build\_versions.json and add .gitlab-ci.yaml example [\#5](https://github.com/voxpupuli/container-voxbox/pull/5) ([rwaffen](https://github.com/rwaffen)) 192 | - Use more precise container image names and add rubocop-performance [\#4](https://github.com/voxpupuli/container-voxbox/pull/4) ([rwaffen](https://github.com/rwaffen)) 193 | 194 | ## [v1.0.0](https://github.com/voxpupuli/container-voxbox/tree/v1.0.0) (2024-03-27) 195 | 196 | [Full Changelog](https://github.com/voxpupuli/container-voxbox/compare/ac1461e6cb5c9f365632f39b551bfd510aeea1ba...v1.0.0) 197 | 198 | **Implemented enhancements:** 199 | 200 | - Add r10k and demo minimal Rakefile [\#1](https://github.com/voxpupuli/container-voxbox/pull/1) ([rwaffen](https://github.com/rwaffen)) 201 | 202 | **Merged pull requests:** 203 | 204 | - Gemfile: add faraday as GCG dependency [\#3](https://github.com/voxpupuli/container-voxbox/pull/3) ([bastelfreak](https://github.com/bastelfreak)) 205 | 206 | 207 | 208 | \* *This Changelog was automatically generated by [github_changelog_generator](https://github.com/github-changelog-generator/github-changelog-generator)* 209 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # Vox Pupuli Test Box 2 | 3 | [![CI](https://github.com/voxpupuli/container-voxbox/actions/workflows/ci.yaml/badge.svg)](https://github.com/voxpupuli/container-voxbox/actions/workflows/ci.yaml) 4 | [![License](https://img.shields.io/github/license/voxpupuli/container-voxbox.svg)](https://github.com/voxpupuli/container-voxbox/blob/main/LICENSE) 5 | [![Sponsored by betadots GmbH](https://img.shields.io/badge/Sponsored%20by-betadots%20GmbH-blue.svg)](https://www.betadots.de) 6 | 7 | --- 8 | 9 | - [Vox Pupuli Test Box](#vox-pupuli-test-box) 10 | - [Introduction](#introduction) 11 | - [Included rubygems](#included-rubygems) 12 | - [Additionally included tools](#additionally-included-tools) 13 | - [Versions](#versions) 14 | - [Usage](#usage) 15 | - [Rake](#rake) 16 | - [release Task](#release-task) 17 | - [spec Task](#spec-task) 18 | - [Available rake tasks](#available-rake-tasks) 19 | - [Onceover](#onceover) 20 | - [Shell](#shell) 21 | - [Puppet](#puppet) 22 | - [puppet-strings](#puppet-strings) 23 | - [puppet-ghostbuster](#puppet-ghostbuster) 24 | - [YAMLlint](#yamllint) 25 | - [JQ](#jq) 26 | - [cURL](#curl) 27 | - [RuboCop](#rubocop) 28 | - [Librarian](#librarian) 29 | - [eyaml](#hiera-eyaml) 30 | - [GitLab](#gitlab) 31 | - [Example GitLab CI configuration](#example-gitlab-ci-configuration) 32 | - [GitLab Codequality Report](#gitlab-codequality-report) 33 | - [GitLab Unit Test Report](#gitlab-unit-test-report) 34 | - [Version Schema](#version-schema) 35 | - [How to release?](#how-to-release) 36 | - [How to contribute?](#how-to-contribute) 37 | 38 | ## Introduction 39 | 40 | This container should be used to test voxpupuli OpenVox/Puppet modules. 41 | It has the voxpupuli-test, -acceptance, -release gems and all dependencies installed. 42 | 43 | ## Informations 44 | 45 | - ⚠ On February 28, 2025, OpenVox/Puppet 7 entered its end-of-life phase. Consequently, no new VoxBox:7 releases will be build. Existing versions will be retained for continued access. 46 | 47 | ## Included rubygems 48 | 49 | see: [Gemfile](voxbox/Gemfile) 50 | 51 | - hiera-eyaml 52 | - librarian 53 | - modulesync 54 | - onceover 55 | - openfact 56 | - openvox 57 | - puppet-ghostbuster 58 | - r10k 59 | - rubocop 60 | - voxpupuli-acceptance 61 | - voxpupuli-release 62 | - voxpupuli-test 63 | 64 | ## Additionally included tools 65 | 66 | - curl 67 | - git 68 | - gpg 69 | - jq 70 | - ssh-client 71 | - yamllint 72 | 73 | ## Versions 74 | 75 | Too see which tool versions are included in the container, see: 76 | 77 | [build_versions.yaml](build_versions.yaml) 78 | 79 | ## Usage 80 | 81 | ### Rake 82 | 83 | Change into the root of a OpenVox/Puppet module and run the container. 84 | Make sure to mount the current directory into the container under `/repo`. 85 | The default entrypoint is rake. 86 | Without any arguments it will run `rake -f /Rakefile -T`. 87 | You can specify a rake task as argument. 88 | See [Available rake tasks](#available-rake-tasks) for more information. 89 | 90 | To guarantee a consistent rake environment, we use `-f /Rakefile` to explicitly specify a Rakefile, 91 | rather than relying on potentially outdated versions in a repository. 92 | The Rakefile being used can be viewed [here](voxbox/Rakefile). 93 | 94 | ```shell 95 | cd puppet-example 96 | podman run -it --rm -v $PWD:/repo:Z ghcr.io/voxpupuli/voxbox:8 # rake -T 97 | podman run -it --rm -v $PWD:/repo:Z ghcr.io/voxpupuli/voxbox:8 spec # rake spec 98 | ``` 99 | 100 | #### release Task 101 | 102 | Using the release rake task: 103 | 104 | ```shell 105 | podman run -it --rm \ 106 | -v $PWD:/repo:Z \ 107 | -v ~/.gitconfig:/etc/gitconfig:ro \ 108 | -v ~/.ssh:/root/.ssh \ 109 | -v ${SSH_AUTH_SOCK}:${SSH_AUTH_SOCK} \ 110 | -e SSH_AUTH_SOCK="${SSH_AUTH_SOCK}" \ 111 | ghcr.io/voxpupuli/voxbox:8 release 112 | ``` 113 | 114 | #### spec Task 115 | 116 | Running only a specific spec: 117 | 118 | ```shell 119 | podman run -it --rm -e "SPEC=spec/classes/example_spec.rb" -v $PWD:/repo:Z ghcr.io/voxpupuli/voxbox:8 spec 120 | ``` 121 | 122 | #### Available rake tasks 123 | 124 | ```shell 125 | rake beaker # Run RSpec code examples 126 | rake build # Build puppet module package 127 | rake build:pdk # Build Puppet module with PDK 128 | rake check # Run static pre release checks 129 | rake check:dot_underscore # Fails if any ._ files are present in directory 130 | rake check:git_ignore # Fails if directories contain the files specified in .gitignore 131 | rake check:symlinks # Fails if symlinks are present in directory 132 | rake check:test_file # Fails if .pp files present in tests folder 133 | rake check:trailing_whitespace # Check for trailing whitespace 134 | rake check_changelog # Check Changelog 135 | rake clean # Clean a built module package 136 | rake compute_dev_version # Print development version of module 137 | rake generate_fixtures # Generate -fixtures.yml based on Puppetfile 138 | rake generate_vendor_cache # Fetches the core modules which are usually bundled in AIO agent 139 | rake help # Display the list of available rake tasks 140 | rake lint # Run puppet-lint 141 | rake lint_fix # Run puppet-lint 142 | rake metadata_lint # Run metadata-json-lint 143 | rake module:build # Build the module using puppet-modulebuilder 144 | rake module:bump # Bump module version to the next patch 145 | rake module:bump:full # Bump module version to the next FULL version 146 | rake module:bump:major # Bump module version to the next MAJOR version 147 | rake module:bump:minor # Bump module version to the next MINOR version 148 | rake module:bump:patch # Bump module version to the next PATCH version 149 | rake module:bump_commit # Bump version and git commit 150 | rake module:bump_commit:full # Bump module version to the next FULL version and git commit 151 | rake module:bump_commit:major # Bump module version to the next MAJOR version and git commit 152 | rake module:bump_commit:minor # Bump module version to the next MINOR version and git commit 153 | rake module:bump_commit:patch # Bump module version to the next PATCH version and git commit 154 | rake module:bump_to_version[new_version] # Bump module to specific version number 155 | rake module:clean # Runs clean again 156 | rake module:dependency[module_name,version] # Set specific module dependency version 157 | rake module:push # Push module to the Puppet Forge 158 | rake module:release # Release the Puppet module, doing a clean, build, bump_commit, tag, push and git push 159 | rake module:tag # Git tag with the current module version 160 | rake module:version # Get current module version 161 | rake module:version:next # Get next module version 162 | rake module:version:next:major # Get the next MAJOR version 163 | rake module:version:next:minor # Get the next MINOR version 164 | rake module:version:next:patch # Get the next PATCH version 165 | rake parallel_spec # Run spec tests in parallel and clean the fixtures directory if successful 166 | rake parallel_spec_standalone # Parallel spec tests 167 | rake r10k:dependencies # Print outdated forge modules 168 | rake r10k:deprecation # Validate that no forge modules are deprecated 169 | rake r10k:duplicates # Check Puppetfile for duplicates 170 | rake r10k:install # Install modules specified in Puppetfile 171 | rake r10k:print_git_conversion # Convert and print forge modules to git format 172 | rake r10k:solve_dependencies[allow_major_bump] # Find missing or outdated module dependencies 173 | rake r10k:syntax # Syntax check Puppetfile 174 | rake r10k:validate # Validate the git urls and branches, refs, or tags 175 | rake release # Release via GitHub Actions 176 | rake release:prepare # Prepare a release 177 | rake release_checks # Runs all necessary checks on a module in preparation for a release 178 | rake rubocop # Run RuboCop 179 | rake rubocop:autocorrect # Autocorrect RuboCop offenses (only when it's safe) 180 | rake rubocop:autocorrect_all # Autocorrect RuboCop offenses (safe and unsafe) 181 | rake spec # Run spec tests and clean the fixtures directory if successful 182 | rake spec:simplecov # Run spec tests with ruby simplecov code coverage 183 | rake spec_clean # Clean up the fixtures directory 184 | rake spec_clean_symlinks # Clean up any fixture symlinks 185 | rake spec_list_json # List spec tests in a JSON document 186 | rake spec_prep # Create the fixtures directory 187 | rake spec_standalone # Run RSpec code examples 188 | rake strings:generate[patterns,debug,backtrace,markup,json,markdown,yard_args] # Generate Puppet documentation with YARD 189 | rake strings:generate:reference[patterns,debug,backtrace] # Generate Puppet Reference documentation 190 | rake strings:gh_pages:update # Update docs on the gh-pages branch and push to GitHub 191 | rake strings:validate:reference[patterns,debug,backtrace] # Validate the reference is up to date 192 | rake syntax # Syntax check for Puppet manifests, templates and Hiera 193 | rake syntax:hiera # Syntax check Hiera config files 194 | rake syntax:manifests # Syntax check Puppet manifests 195 | rake syntax:templates # Syntax check Puppet templates 196 | rake test # Run tests 197 | rake travis_release # Deprecated: use the "release" task instead 198 | rake validate # Check syntax of Ruby files and call :syntax and :metadata_lint 199 | rake voxpupuli:custom:lint_all # Lint with all puppet-lint checks 200 | ``` 201 | 202 | ### Onceover 203 | 204 | If you want to run onceover, you have to override the entrypoint: 205 | 206 | ```shell 207 | podman run -it --rm -v $PWD:/repo:Z --entrypoint onceover ghcr.io/voxpupuli/voxbox:8 help 208 | ``` 209 | 210 | Onceover allows you to run tests against your control-repository. 211 | 212 | Initialize onceover: 213 | 214 | ```shell 215 | podman run -it --rm -v $PWD:/repo:Z --entrypoint onceover ghcr.io/voxpupuli/voxbox:latest init 216 | ``` 217 | 218 | Running spec tests: 219 | 220 | ```shell 221 | podman run -it --rm -v $PWD:/repo:Z --entrypoint onceover ghcr.io/voxpupuli/voxbox:8 run spec 222 | ``` 223 | 224 | Running spec test with internal git+ssh modules in Puppetfile: 225 | 226 | ```shell 227 | podman run -it --rm \ 228 | -v ~/.ssh:/root/.ssh:Z \ 229 | -v $PWD:/repo:Z \ 230 | --entrypoint onceover ghcr.io/voxpupuli/voxbox:latest run spec 231 | ``` 232 | 233 | Running spec tests with puppet output: 234 | 235 | ```shell 236 | podman run -it --rm \ 237 | -v $PWD:/repo:Z \ 238 | -e SHOW_PUPPET_OUTPUT=true \ 239 | --entrypoint onceover ghcr.io/voxpupuli/voxbox:latest run spec 240 | ``` 241 | 242 | Other commands are: 243 | 244 | | Command | What it does | 245 | | -------------------- | -------------------------------------------- | 246 | | `show puppetfile` | Analyze the Puppetfile and show open updates | 247 | |  `update puppetfile` | Update modules | 248 | 249 | Further commands, required configuration and usage is described in the [onceover repository](https://github.com/voxpupuli/onceover). 250 | 251 | ### Shell 252 | 253 | If you need a shell, you have to override the entrypoint: 254 | 255 | ```shell 256 | podman run -it --rm -v $PWD:/repo:Z --entrypoint ash ghcr.io/voxpupuli/voxbox:8 257 | ``` 258 | 259 | ### Puppet 260 | 261 | If you want to execute puppet change the entrypoint to `puppet` and pass subcommands/parameters to it. 262 | 263 | ```shell 264 | podman run -it --rm -v $PWD:/repo:Z --entrypoint puppet ghcr.io/voxpupuli/voxbox:8 --help 265 | ``` 266 | 267 | #### puppet-strings 268 | 269 | ```shell 270 | podman run -it --rm -v $PWD:/repo:Z --entrypoint puppet ghcr.io/voxpupuli/voxbox:8 strings --help 271 | ``` 272 | 273 | ## puppet-ghostbuster 274 | 275 | If you want to execute puppet-ghostbuster change the entrypoint to `ash` and pass the command to the container. 276 | Ghostbuster needs a connection to the OpenVoxDB/PuppetDB, so you have to provide the environment variables. 277 | You can find them in the documentation of the [puppet-ghostbuster](https://github.com/voxpupuli/puppet-ghostbuster) repository. 278 | 279 | Ghostbuster supports the following checks: 280 | 281 | - ghostbuster_classes 282 | - ghostbuster_defines 283 | - ghostbuster_facts 284 | - ghostbuster_files 285 | - ghostbuster_functions 286 | - ghostbuster_hiera_files 287 | - ghostbuster_templates 288 | - ghostbuster_types 289 | 290 | They can be combined with `--only-checks` and listed in a comma separated list. 291 | 292 | ```shell 293 | podman run -it --rm -v $PWD:/repo:Z --entrypoint ash ghcr.io/voxpupuli/voxbox:8 294 | find . -type f -exec bundle exec --gemfile /Gemfile puppet-lint --only-checks ghostbuster_classes,ghostbuster_facts {} \+ 295 | ``` 296 | 297 | ### YAMLlint 298 | 299 | If you want to execute yamllint change the entryoint to `yamllint` and pass a folder to the container, f.e. `.`. 300 | 301 | ```shell 302 | podman run -it --rm -v $PWD:/repo:Z --entrypoint yamllint ghcr.io/voxpupuli/voxbox:8 . 303 | ``` 304 | 305 | ### JQ 306 | 307 | If you want to execute jq change the entrypoint to `jq` and pass a query/parameter to the container. 308 | 309 | ```shell 310 | podman run -it --rm -v $PWD:/repo:Z --entrypoint jq ghcr.io/voxpupuli/voxbox:8 --help 311 | ``` 312 | 313 | ### cURL 314 | 315 | If you want to execute curl change the entrypoint to `curl` and pass a query/parameter to the container. 316 | 317 | ```shell 318 | podman run -it --rm -v $PWD:/repo:Z --entrypoint curl ghcr.io/voxpupuli/voxbox:8 --help 319 | ``` 320 | 321 | ### RuboCop 322 | 323 | If you want to execute RuboCop directly change the entrypoint to `rubocop` and pass a subcommands/parameter to the container. 324 | 325 | ```shell 326 | podman run -it --rm -v $PWD:/repo:Z --entrypoint rubocop ghcr.io/voxpupuli/voxbox:8 327 | podman run -it --rm -v $PWD:/repo:Z --entrypoint rubocop ghcr.io/voxpupuli/voxbox:8 --auto-gen-config 328 | ``` 329 | 330 | ### Librarian 331 | 332 | If you want to execute librarian change the entrypoint to `librarian-puppet` and pass a query/parameter to the container. 333 | 334 | ```shell 335 | podman run -it --rm -v $PWD:/repo:Z --entrypoint librarian-puppet ghcr.io/voxpupuli/voxbox:8 help 336 | ``` 337 | 338 | ### hiera-eyaml 339 | 340 | If you want to encrypt/decrypt data using plain `eyaml`, change the entrypoint like so : 341 | 342 | ```shell 343 | podman run -it --rm -v $PWD:/repo:Z --entrypoint eyaml ghcr.io/voxpupuli/voxbox:8 edit /repo/ 344 | ``` 345 | 346 | ## EasyVoxBox (evb) 347 | 348 | The [evb script](evb) shortens the commands to be typed for running voxbox. Additionally, it does not care about the sequence of 349 | options, which can be useful for setting shell aliases. To run the command you must change into any subdirectory of an openvox module 350 | (with a metadata.json file) or a control repository (with a Puppetfile). 351 | 352 | Display the evb help message: 353 | 354 | ```shell 355 | $ evb help 356 | Usage: /usr/local/bin/evb [options] [command] 357 | 358 | available options: 359 | --noop : print the command to run, but do not run it 360 | --entrypoint : use a different entrypoint 361 | examples for available endpoints are: 362 | onceover, ash, puppet, yamllint, jq, curl, rubocop 363 | default: no entrypoint specified 364 | --image image : use a different image (default ghcr.io/voxpupuli/voxbox:8) 365 | --env VAR=val : specify environment variables (can be used multiple times) 366 | Remark: the term './' in a assignment will be replaced with 367 | the correct path to be used in the container. 368 | Example: if you start the script in ~/openvox-supermodule/spec/classes 369 | and set --env SPEC=./supermodule_spec.rb we will 370 | run VoxBox with -e SPEC=spec/classes/supermodule_spec.rb 371 | --volume vol : specify an additional volume to put into the container 372 | see podman man page how to specify 'vol'. (no path magic is done ;)) 373 | --runcmd : this lets you change the program used to start the container 374 | if not set explicit it looks for podman or docker. 375 | 376 | available command: 377 | help : print this help message and exit 378 | 379 | commands/options not listed here are passed to VoxBox as is. 380 | use the '--noop' option to print the detailed call to VoxBox. 381 | ``` 382 | 383 | See the command that would be executed (dropping the --noop option will run the command): 384 | 385 | ```shell 386 | evb --noop # for rake -T 387 | evb --noop spec # for rake spec 388 | evb --noop --env SPEC=./example_spec.rb spec # for only a specific spec in the current subdirectory 389 | evb --noop --entrypoint onceover --help # onceover help 390 | 391 | # or the release rake task 392 | evb --volume ~/.gitconfig:/etc/gitconfig:ro \ 393 | --volume ~/.ssh:/root/.ssh \ 394 | --volume ${SSH_AUTH_SOCK}:${SSH_AUTH_SOCK} \ 395 | --env SSH_AUTH_SOCK="${SSH_AUTH_SOCK}" \ 396 | release --noop 397 | ``` 398 | 399 | ## GitLab 400 | 401 | ### Example GitLab CI configuration 402 | 403 | see [.gitlab-ci.yml](.gitlab-ci.yml) 404 | 405 | ### GitLab Codequality Report 406 | 407 | - 408 | - 409 | 410 | Example usage: 411 | 412 | ```yaml 413 | code-quality: 414 | image: 415 | name: ghcr.io/voxpupuli/voxbox:8 416 | entrypoint: [""] 417 | stage: verify 418 | script: 419 | - rake -f /Rakefile voxpupuli:custom:lint_all 420 | variables: 421 | # setting this variable makes puppet-lint create the json file 422 | # needed for the code quality report 423 | CODECLIMATE_REPORT_FILE: "gl-code-quality-report.json" 424 | artifacts: 425 | when: always 426 | reports: 427 | codequality: gl-code-quality-report.json 428 | expire_in: 1 week 429 | ``` 430 | 431 | ### GitLab Unit Test Report 432 | 433 | add to .rspec file: 434 | 435 | ```text 436 | --format RspecJunitFormatter 437 | --out rspec.xml 438 | ``` 439 | 440 | add to .gitlab-ci.yml: 441 | 442 | ```yaml 443 | rspec: 444 | image: 445 | name: ghcr.io/voxpupuli/voxbox:8 446 | entrypoint: [""] 447 | stage: test 448 | script: 449 | - rake -f /Rakefile spec 450 | artifacts: 451 | when: always 452 | reports: 453 | junit: rspec.xml 454 | expire_in: 1 week 455 | ``` 456 | 457 | ## Version Schema 458 | 459 | The version schema has the following layout: 460 | 461 | ```text 462 | ..-v.. 463 | -v.. 464 | 465 | latest 466 | ``` 467 | 468 | Example usage: 469 | 470 | ```shell 471 | podman pull ghcr.io/voxpupuli/voxbox:8.5.1-v1.2.3 472 | podman pull ghcr.io/voxpupuli/voxbox:8-v1.2.3 473 | podman pull ghcr.io/voxpupuli/voxbox:8 474 | podman pull ghcr.io/voxpupuli/voxbox:latest 475 | ``` 476 | 477 | | Name | Description | 478 | | --------------- | ----------------------------------------------------------------- | 479 | | puppet.major | Describes the contained major Puppet version (7 or 8) | 480 | | puppet.minor | Describes the contained minor Puppet version | 481 | | puppet.patch | Describes the contained patchlevel Puppet version | 482 | | container.major | Describes breaking changes without backward compatibility | 483 | | container.minor | Describes new features or refactoring with backward compatibility | 484 | | container.patch | Describes if minor changes or bugfixes have been implemented | 485 | 486 | ## How to release? 487 | 488 | see [RELEASE.md](RELEASE.md) 489 | 490 | ## How to contribute? 491 | 492 | see [CONTRIBUTING.md](CONTRIBUTING.md) 493 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | GNU AFFERO GENERAL PUBLIC LICENSE 2 | Version 3, 19 November 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU Affero General Public License is a free, copyleft license for 11 | software and other kinds of works, specifically designed to ensure 12 | cooperation with the community in the case of network server software. 13 | 14 | The licenses for most software and other practical works are designed 15 | to take away your freedom to share and change the works. By contrast, 16 | our General Public Licenses are intended to guarantee your freedom to 17 | share and change all versions of a program--to make sure it remains free 18 | software for all its users. 19 | 20 | When we speak of free software, we are referring to freedom, not 21 | price. Our General Public Licenses are designed to make sure that you 22 | have the freedom to distribute copies of free software (and charge for 23 | them if you wish), that you receive source code or can get it if you 24 | want it, that you can change the software or use pieces of it in new 25 | free programs, and that you know you can do these things. 26 | 27 | Developers that use our General Public Licenses protect your rights 28 | with two steps: (1) assert copyright on the software, and (2) offer 29 | you this License which gives you legal permission to copy, distribute 30 | and/or modify the software. 31 | 32 | A secondary benefit of defending all users' freedom is that 33 | improvements made in alternate versions of the program, if they 34 | receive widespread use, become available for other developers to 35 | incorporate. Many developers of free software are heartened and 36 | encouraged by the resulting cooperation. However, in the case of 37 | software used on network servers, this result may fail to come about. 38 | The GNU General Public License permits making a modified version and 39 | letting the public access it on a server without ever releasing its 40 | source code to the public. 41 | 42 | The GNU Affero General Public License is designed specifically to 43 | ensure that, in such cases, the modified source code becomes available 44 | to the community. It requires the operator of a network server to 45 | provide the source code of the modified version running there to the 46 | users of that server. Therefore, public use of a modified version, on 47 | a publicly accessible server, gives the public access to the source 48 | code of the modified version. 49 | 50 | An older license, called the Affero General Public License and 51 | published by Affero, was designed to accomplish similar goals. This is 52 | a different license, not a version of the Affero GPL, but Affero has 53 | released a new version of the Affero GPL which permits relicensing under 54 | this license. 55 | 56 | The precise terms and conditions for copying, distribution and 57 | modification follow. 58 | 59 | TERMS AND CONDITIONS 60 | 61 | 0. Definitions. 62 | 63 | "This License" refers to version 3 of the GNU Affero General Public License. 64 | 65 | "Copyright" also means copyright-like laws that apply to other kinds of 66 | works, such as semiconductor masks. 67 | 68 | "The Program" refers to any copyrightable work licensed under this 69 | License. Each licensee is addressed as "you". "Licensees" and 70 | "recipients" may be individuals or organizations. 71 | 72 | To "modify" a work means to copy from or adapt all or part of the work 73 | in a fashion requiring copyright permission, other than the making of an 74 | exact copy. The resulting work is called a "modified version" of the 75 | earlier work or a work "based on" the earlier work. 76 | 77 | A "covered work" means either the unmodified Program or a work based 78 | on the Program. 79 | 80 | To "propagate" a work means to do anything with it that, without 81 | permission, would make you directly or secondarily liable for 82 | infringement under applicable copyright law, except executing it on a 83 | computer or modifying a private copy. Propagation includes copying, 84 | distribution (with or without modification), making available to the 85 | public, and in some countries other activities as well. 86 | 87 | To "convey" a work means any kind of propagation that enables other 88 | parties to make or receive copies. Mere interaction with a user through 89 | a computer network, with no transfer of a copy, is not conveying. 90 | 91 | An interactive user interface displays "Appropriate Legal Notices" 92 | to the extent that it includes a convenient and prominently visible 93 | feature that (1) displays an appropriate copyright notice, and (2) 94 | tells the user that there is no warranty for the work (except to the 95 | extent that warranties are provided), that licensees may convey the 96 | work under this License, and how to view a copy of this License. If 97 | the interface presents a list of user commands or options, such as a 98 | menu, a prominent item in the list meets this criterion. 99 | 100 | 1. Source Code. 101 | 102 | The "source code" for a work means the preferred form of the work 103 | for making modifications to it. "Object code" means any non-source 104 | form of a work. 105 | 106 | A "Standard Interface" means an interface that either is an official 107 | standard defined by a recognized standards body, or, in the case of 108 | interfaces specified for a particular programming language, one that 109 | is widely used among developers working in that language. 110 | 111 | The "System Libraries" of an executable work include anything, other 112 | than the work as a whole, that (a) is included in the normal form of 113 | packaging a Major Component, but which is not part of that Major 114 | Component, and (b) serves only to enable use of the work with that 115 | Major Component, or to implement a Standard Interface for which an 116 | implementation is available to the public in source code form. A 117 | "Major Component", in this context, means a major essential component 118 | (kernel, window system, and so on) of the specific operating system 119 | (if any) on which the executable work runs, or a compiler used to 120 | produce the work, or an object code interpreter used to run it. 121 | 122 | The "Corresponding Source" for a work in object code form means all 123 | the source code needed to generate, install, and (for an executable 124 | work) run the object code and to modify the work, including scripts to 125 | control those activities. However, it does not include the work's 126 | System Libraries, or general-purpose tools or generally available free 127 | programs which are used unmodified in performing those activities but 128 | which are not part of the work. For example, Corresponding Source 129 | includes interface definition files associated with source files for 130 | the work, and the source code for shared libraries and dynamically 131 | linked subprograms that the work is specifically designed to require, 132 | such as by intimate data communication or control flow between those 133 | subprograms and other parts of the work. 134 | 135 | The Corresponding Source need not include anything that users 136 | can regenerate automatically from other parts of the Corresponding 137 | Source. 138 | 139 | The Corresponding Source for a work in source code form is that 140 | same work. 141 | 142 | 2. Basic Permissions. 143 | 144 | All rights granted under this License are granted for the term of 145 | copyright on the Program, and are irrevocable provided the stated 146 | conditions are met. This License explicitly affirms your unlimited 147 | permission to run the unmodified Program. The output from running a 148 | covered work is covered by this License only if the output, given its 149 | content, constitutes a covered work. This License acknowledges your 150 | rights of fair use or other equivalent, as provided by copyright law. 151 | 152 | You may make, run and propagate covered works that you do not 153 | convey, without conditions so long as your license otherwise remains 154 | in force. You may convey covered works to others for the sole purpose 155 | of having them make modifications exclusively for you, or provide you 156 | with facilities for running those works, provided that you comply with 157 | the terms of this License in conveying all material for which you do 158 | not control copyright. Those thus making or running the covered works 159 | for you must do so exclusively on your behalf, under your direction 160 | and control, on terms that prohibit them from making any copies of 161 | your copyrighted material outside their relationship with you. 162 | 163 | Conveying under any other circumstances is permitted solely under 164 | the conditions stated below. Sublicensing is not allowed; section 10 165 | makes it unnecessary. 166 | 167 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 168 | 169 | No covered work shall be deemed part of an effective technological 170 | measure under any applicable law fulfilling obligations under article 171 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 172 | similar laws prohibiting or restricting circumvention of such 173 | measures. 174 | 175 | When you convey a covered work, you waive any legal power to forbid 176 | circumvention of technological measures to the extent such circumvention 177 | is effected by exercising rights under this License with respect to 178 | the covered work, and you disclaim any intention to limit operation or 179 | modification of the work as a means of enforcing, against the work's 180 | users, your or third parties' legal rights to forbid circumvention of 181 | technological measures. 182 | 183 | 4. Conveying Verbatim Copies. 184 | 185 | You may convey verbatim copies of the Program's source code as you 186 | receive it, in any medium, provided that you conspicuously and 187 | appropriately publish on each copy an appropriate copyright notice; 188 | keep intact all notices stating that this License and any 189 | non-permissive terms added in accord with section 7 apply to the code; 190 | keep intact all notices of the absence of any warranty; and give all 191 | recipients a copy of this License along with the Program. 192 | 193 | You may charge any price or no price for each copy that you convey, 194 | and you may offer support or warranty protection for a fee. 195 | 196 | 5. Conveying Modified Source Versions. 197 | 198 | You may convey a work based on the Program, or the modifications to 199 | produce it from the Program, in the form of source code under the 200 | terms of section 4, provided that you also meet all of these conditions: 201 | 202 | a) The work must carry prominent notices stating that you modified 203 | it, and giving a relevant date. 204 | 205 | b) The work must carry prominent notices stating that it is 206 | released under this License and any conditions added under section 207 | 7. This requirement modifies the requirement in section 4 to 208 | "keep intact all notices". 209 | 210 | c) You must license the entire work, as a whole, under this 211 | License to anyone who comes into possession of a copy. This 212 | License will therefore apply, along with any applicable section 7 213 | additional terms, to the whole of the work, and all its parts, 214 | regardless of how they are packaged. This License gives no 215 | permission to license the work in any other way, but it does not 216 | invalidate such permission if you have separately received it. 217 | 218 | d) If the work has interactive user interfaces, each must display 219 | Appropriate Legal Notices; however, if the Program has interactive 220 | interfaces that do not display Appropriate Legal Notices, your 221 | work need not make them do so. 222 | 223 | A compilation of a covered work with other separate and independent 224 | works, which are not by their nature extensions of the covered work, 225 | and which are not combined with it such as to form a larger program, 226 | in or on a volume of a storage or distribution medium, is called an 227 | "aggregate" if the compilation and its resulting copyright are not 228 | used to limit the access or legal rights of the compilation's users 229 | beyond what the individual works permit. Inclusion of a covered work 230 | in an aggregate does not cause this License to apply to the other 231 | parts of the aggregate. 232 | 233 | 6. Conveying Non-Source Forms. 234 | 235 | You may convey a covered work in object code form under the terms 236 | of sections 4 and 5, provided that you also convey the 237 | machine-readable Corresponding Source under the terms of this License, 238 | in one of these ways: 239 | 240 | a) Convey the object code in, or embodied in, a physical product 241 | (including a physical distribution medium), accompanied by the 242 | Corresponding Source fixed on a durable physical medium 243 | customarily used for software interchange. 244 | 245 | b) Convey the object code in, or embodied in, a physical product 246 | (including a physical distribution medium), accompanied by a 247 | written offer, valid for at least three years and valid for as 248 | long as you offer spare parts or customer support for that product 249 | model, to give anyone who possesses the object code either (1) a 250 | copy of the Corresponding Source for all the software in the 251 | product that is covered by this License, on a durable physical 252 | medium customarily used for software interchange, for a price no 253 | more than your reasonable cost of physically performing this 254 | conveying of source, or (2) access to copy the 255 | Corresponding Source from a network server at no charge. 256 | 257 | c) Convey individual copies of the object code with a copy of the 258 | written offer to provide the Corresponding Source. This 259 | alternative is allowed only occasionally and noncommercially, and 260 | only if you received the object code with such an offer, in accord 261 | with subsection 6b. 262 | 263 | d) Convey the object code by offering access from a designated 264 | place (gratis or for a charge), and offer equivalent access to the 265 | Corresponding Source in the same way through the same place at no 266 | further charge. You need not require recipients to copy the 267 | Corresponding Source along with the object code. If the place to 268 | copy the object code is a network server, the Corresponding Source 269 | may be on a different server (operated by you or a third party) 270 | that supports equivalent copying facilities, provided you maintain 271 | clear directions next to the object code saying where to find the 272 | Corresponding Source. Regardless of what server hosts the 273 | Corresponding Source, you remain obligated to ensure that it is 274 | available for as long as needed to satisfy these requirements. 275 | 276 | e) Convey the object code using peer-to-peer transmission, provided 277 | you inform other peers where the object code and Corresponding 278 | Source of the work are being offered to the general public at no 279 | charge under subsection 6d. 280 | 281 | A separable portion of the object code, whose source code is excluded 282 | from the Corresponding Source as a System Library, need not be 283 | included in conveying the object code work. 284 | 285 | A "User Product" is either (1) a "consumer product", which means any 286 | tangible personal property which is normally used for personal, family, 287 | or household purposes, or (2) anything designed or sold for incorporation 288 | into a dwelling. In determining whether a product is a consumer product, 289 | doubtful cases shall be resolved in favor of coverage. For a particular 290 | product received by a particular user, "normally used" refers to a 291 | typical or common use of that class of product, regardless of the status 292 | of the particular user or of the way in which the particular user 293 | actually uses, or expects or is expected to use, the product. A product 294 | is a consumer product regardless of whether the product has substantial 295 | commercial, industrial or non-consumer uses, unless such uses represent 296 | the only significant mode of use of the product. 297 | 298 | "Installation Information" for a User Product means any methods, 299 | procedures, authorization keys, or other information required to install 300 | and execute modified versions of a covered work in that User Product from 301 | a modified version of its Corresponding Source. The information must 302 | suffice to ensure that the continued functioning of the modified object 303 | code is in no case prevented or interfered with solely because 304 | modification has been made. 305 | 306 | If you convey an object code work under this section in, or with, or 307 | specifically for use in, a User Product, and the conveying occurs as 308 | part of a transaction in which the right of possession and use of the 309 | User Product is transferred to the recipient in perpetuity or for a 310 | fixed term (regardless of how the transaction is characterized), the 311 | Corresponding Source conveyed under this section must be accompanied 312 | by the Installation Information. But this requirement does not apply 313 | if neither you nor any third party retains the ability to install 314 | modified object code on the User Product (for example, the work has 315 | been installed in ROM). 316 | 317 | The requirement to provide Installation Information does not include a 318 | requirement to continue to provide support service, warranty, or updates 319 | for a work that has been modified or installed by the recipient, or for 320 | the User Product in which it has been modified or installed. Access to a 321 | network may be denied when the modification itself materially and 322 | adversely affects the operation of the network or violates the rules and 323 | protocols for communication across the network. 324 | 325 | Corresponding Source conveyed, and Installation Information provided, 326 | in accord with this section must be in a format that is publicly 327 | documented (and with an implementation available to the public in 328 | source code form), and must require no special password or key for 329 | unpacking, reading or copying. 330 | 331 | 7. Additional Terms. 332 | 333 | "Additional permissions" are terms that supplement the terms of this 334 | License by making exceptions from one or more of its conditions. 335 | Additional permissions that are applicable to the entire Program shall 336 | be treated as though they were included in this License, to the extent 337 | that they are valid under applicable law. If additional permissions 338 | apply only to part of the Program, that part may be used separately 339 | under those permissions, but the entire Program remains governed by 340 | this License without regard to the additional permissions. 341 | 342 | When you convey a copy of a covered work, you may at your option 343 | remove any additional permissions from that copy, or from any part of 344 | it. (Additional permissions may be written to require their own 345 | removal in certain cases when you modify the work.) You may place 346 | additional permissions on material, added by you to a covered work, 347 | for which you have or can give appropriate copyright permission. 348 | 349 | Notwithstanding any other provision of this License, for material you 350 | add to a covered work, you may (if authorized by the copyright holders of 351 | that material) supplement the terms of this License with terms: 352 | 353 | a) Disclaiming warranty or limiting liability differently from the 354 | terms of sections 15 and 16 of this License; or 355 | 356 | b) Requiring preservation of specified reasonable legal notices or 357 | author attributions in that material or in the Appropriate Legal 358 | Notices displayed by works containing it; or 359 | 360 | c) Prohibiting misrepresentation of the origin of that material, or 361 | requiring that modified versions of such material be marked in 362 | reasonable ways as different from the original version; or 363 | 364 | d) Limiting the use for publicity purposes of names of licensors or 365 | authors of the material; or 366 | 367 | e) Declining to grant rights under trademark law for use of some 368 | trade names, trademarks, or service marks; or 369 | 370 | f) Requiring indemnification of licensors and authors of that 371 | material by anyone who conveys the material (or modified versions of 372 | it) with contractual assumptions of liability to the recipient, for 373 | any liability that these contractual assumptions directly impose on 374 | those licensors and authors. 375 | 376 | All other non-permissive additional terms are considered "further 377 | restrictions" within the meaning of section 10. If the Program as you 378 | received it, or any part of it, contains a notice stating that it is 379 | governed by this License along with a term that is a further 380 | restriction, you may remove that term. If a license document contains 381 | a further restriction but permits relicensing or conveying under this 382 | License, you may add to a covered work material governed by the terms 383 | of that license document, provided that the further restriction does 384 | not survive such relicensing or conveying. 385 | 386 | If you add terms to a covered work in accord with this section, you 387 | must place, in the relevant source files, a statement of the 388 | additional terms that apply to those files, or a notice indicating 389 | where to find the applicable terms. 390 | 391 | Additional terms, permissive or non-permissive, may be stated in the 392 | form of a separately written license, or stated as exceptions; 393 | the above requirements apply either way. 394 | 395 | 8. Termination. 396 | 397 | You may not propagate or modify a covered work except as expressly 398 | provided under this License. Any attempt otherwise to propagate or 399 | modify it is void, and will automatically terminate your rights under 400 | this License (including any patent licenses granted under the third 401 | paragraph of section 11). 402 | 403 | However, if you cease all violation of this License, then your 404 | license from a particular copyright holder is reinstated (a) 405 | provisionally, unless and until the copyright holder explicitly and 406 | finally terminates your license, and (b) permanently, if the copyright 407 | holder fails to notify you of the violation by some reasonable means 408 | prior to 60 days after the cessation. 409 | 410 | Moreover, your license from a particular copyright holder is 411 | reinstated permanently if the copyright holder notifies you of the 412 | violation by some reasonable means, this is the first time you have 413 | received notice of violation of this License (for any work) from that 414 | copyright holder, and you cure the violation prior to 30 days after 415 | your receipt of the notice. 416 | 417 | Termination of your rights under this section does not terminate the 418 | licenses of parties who have received copies or rights from you under 419 | this License. If your rights have been terminated and not permanently 420 | reinstated, you do not qualify to receive new licenses for the same 421 | material under section 10. 422 | 423 | 9. Acceptance Not Required for Having Copies. 424 | 425 | You are not required to accept this License in order to receive or 426 | run a copy of the Program. Ancillary propagation of a covered work 427 | occurring solely as a consequence of using peer-to-peer transmission 428 | to receive a copy likewise does not require acceptance. However, 429 | nothing other than this License grants you permission to propagate or 430 | modify any covered work. These actions infringe copyright if you do 431 | not accept this License. Therefore, by modifying or propagating a 432 | covered work, you indicate your acceptance of this License to do so. 433 | 434 | 10. Automatic Licensing of Downstream Recipients. 435 | 436 | Each time you convey a covered work, the recipient automatically 437 | receives a license from the original licensors, to run, modify and 438 | propagate that work, subject to this License. You are not responsible 439 | for enforcing compliance by third parties with this License. 440 | 441 | An "entity transaction" is a transaction transferring control of an 442 | organization, or substantially all assets of one, or subdividing an 443 | organization, or merging organizations. If propagation of a covered 444 | work results from an entity transaction, each party to that 445 | transaction who receives a copy of the work also receives whatever 446 | licenses to the work the party's predecessor in interest had or could 447 | give under the previous paragraph, plus a right to possession of the 448 | Corresponding Source of the work from the predecessor in interest, if 449 | the predecessor has it or can get it with reasonable efforts. 450 | 451 | You may not impose any further restrictions on the exercise of the 452 | rights granted or affirmed under this License. For example, you may 453 | not impose a license fee, royalty, or other charge for exercise of 454 | rights granted under this License, and you may not initiate litigation 455 | (including a cross-claim or counterclaim in a lawsuit) alleging that 456 | any patent claim is infringed by making, using, selling, offering for 457 | sale, or importing the Program or any portion of it. 458 | 459 | 11. Patents. 460 | 461 | A "contributor" is a copyright holder who authorizes use under this 462 | License of the Program or a work on which the Program is based. The 463 | work thus licensed is called the contributor's "contributor version". 464 | 465 | A contributor's "essential patent claims" are all patent claims 466 | owned or controlled by the contributor, whether already acquired or 467 | hereafter acquired, that would be infringed by some manner, permitted 468 | by this License, of making, using, or selling its contributor version, 469 | but do not include claims that would be infringed only as a 470 | consequence of further modification of the contributor version. For 471 | purposes of this definition, "control" includes the right to grant 472 | patent sublicenses in a manner consistent with the requirements of 473 | this License. 474 | 475 | Each contributor grants you a non-exclusive, worldwide, royalty-free 476 | patent license under the contributor's essential patent claims, to 477 | make, use, sell, offer for sale, import and otherwise run, modify and 478 | propagate the contents of its contributor version. 479 | 480 | In the following three paragraphs, a "patent license" is any express 481 | agreement or commitment, however denominated, not to enforce a patent 482 | (such as an express permission to practice a patent or covenant not to 483 | sue for patent infringement). To "grant" such a patent license to a 484 | party means to make such an agreement or commitment not to enforce a 485 | patent against the party. 486 | 487 | If you convey a covered work, knowingly relying on a patent license, 488 | and the Corresponding Source of the work is not available for anyone 489 | to copy, free of charge and under the terms of this License, through a 490 | publicly available network server or other readily accessible means, 491 | then you must either (1) cause the Corresponding Source to be so 492 | available, or (2) arrange to deprive yourself of the benefit of the 493 | patent license for this particular work, or (3) arrange, in a manner 494 | consistent with the requirements of this License, to extend the patent 495 | license to downstream recipients. "Knowingly relying" means you have 496 | actual knowledge that, but for the patent license, your conveying the 497 | covered work in a country, or your recipient's use of the covered work 498 | in a country, would infringe one or more identifiable patents in that 499 | country that you have reason to believe are valid. 500 | 501 | If, pursuant to or in connection with a single transaction or 502 | arrangement, you convey, or propagate by procuring conveyance of, a 503 | covered work, and grant a patent license to some of the parties 504 | receiving the covered work authorizing them to use, propagate, modify 505 | or convey a specific copy of the covered work, then the patent license 506 | you grant is automatically extended to all recipients of the covered 507 | work and works based on it. 508 | 509 | A patent license is "discriminatory" if it does not include within 510 | the scope of its coverage, prohibits the exercise of, or is 511 | conditioned on the non-exercise of one or more of the rights that are 512 | specifically granted under this License. You may not convey a covered 513 | work if you are a party to an arrangement with a third party that is 514 | in the business of distributing software, under which you make payment 515 | to the third party based on the extent of your activity of conveying 516 | the work, and under which the third party grants, to any of the 517 | parties who would receive the covered work from you, a discriminatory 518 | patent license (a) in connection with copies of the covered work 519 | conveyed by you (or copies made from those copies), or (b) primarily 520 | for and in connection with specific products or compilations that 521 | contain the covered work, unless you entered into that arrangement, 522 | or that patent license was granted, prior to 28 March 2007. 523 | 524 | Nothing in this License shall be construed as excluding or limiting 525 | any implied license or other defenses to infringement that may 526 | otherwise be available to you under applicable patent law. 527 | 528 | 12. No Surrender of Others' Freedom. 529 | 530 | If conditions are imposed on you (whether by court order, agreement or 531 | otherwise) that contradict the conditions of this License, they do not 532 | excuse you from the conditions of this License. If you cannot convey a 533 | covered work so as to satisfy simultaneously your obligations under this 534 | License and any other pertinent obligations, then as a consequence you may 535 | not convey it at all. For example, if you agree to terms that obligate you 536 | to collect a royalty for further conveying from those to whom you convey 537 | the Program, the only way you could satisfy both those terms and this 538 | License would be to refrain entirely from conveying the Program. 539 | 540 | 13. Remote Network Interaction; Use with the GNU General Public License. 541 | 542 | Notwithstanding any other provision of this License, if you modify the 543 | Program, your modified version must prominently offer all users 544 | interacting with it remotely through a computer network (if your version 545 | supports such interaction) an opportunity to receive the Corresponding 546 | Source of your version by providing access to the Corresponding Source 547 | from a network server at no charge, through some standard or customary 548 | means of facilitating copying of software. This Corresponding Source 549 | shall include the Corresponding Source for any work covered by version 3 550 | of the GNU General Public License that is incorporated pursuant to the 551 | following paragraph. 552 | 553 | Notwithstanding any other provision of this License, you have 554 | permission to link or combine any covered work with a work licensed 555 | under version 3 of the GNU General Public License into a single 556 | combined work, and to convey the resulting work. The terms of this 557 | License will continue to apply to the part which is the covered work, 558 | but the work with which it is combined will remain governed by version 559 | 3 of the GNU General Public License. 560 | 561 | 14. Revised Versions of this License. 562 | 563 | The Free Software Foundation may publish revised and/or new versions of 564 | the GNU Affero General Public License from time to time. Such new versions 565 | will be similar in spirit to the present version, but may differ in detail to 566 | address new problems or concerns. 567 | 568 | Each version is given a distinguishing version number. If the 569 | Program specifies that a certain numbered version of the GNU Affero General 570 | Public License "or any later version" applies to it, you have the 571 | option of following the terms and conditions either of that numbered 572 | version or of any later version published by the Free Software 573 | Foundation. If the Program does not specify a version number of the 574 | GNU Affero General Public License, you may choose any version ever published 575 | by the Free Software Foundation. 576 | 577 | If the Program specifies that a proxy can decide which future 578 | versions of the GNU Affero General Public License can be used, that proxy's 579 | public statement of acceptance of a version permanently authorizes you 580 | to choose that version for the Program. 581 | 582 | Later license versions may give you additional or different 583 | permissions. However, no additional obligations are imposed on any 584 | author or copyright holder as a result of your choosing to follow a 585 | later version. 586 | 587 | 15. Disclaimer of Warranty. 588 | 589 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 590 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 591 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 592 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 593 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 594 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 595 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 596 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 597 | 598 | 16. Limitation of Liability. 599 | 600 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 601 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 602 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 603 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 604 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 605 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 606 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 607 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 608 | SUCH DAMAGES. 609 | 610 | 17. Interpretation of Sections 15 and 16. 611 | 612 | If the disclaimer of warranty and limitation of liability provided 613 | above cannot be given local legal effect according to their terms, 614 | reviewing courts shall apply local law that most closely approximates 615 | an absolute waiver of all civil liability in connection with the 616 | Program, unless a warranty or assumption of liability accompanies a 617 | copy of the Program in return for a fee. 618 | 619 | END OF TERMS AND CONDITIONS 620 | 621 | How to Apply These Terms to Your New Programs 622 | 623 | If you develop a new program, and you want it to be of the greatest 624 | possible use to the public, the best way to achieve this is to make it 625 | free software which everyone can redistribute and change under these terms. 626 | 627 | To do so, attach the following notices to the program. It is safest 628 | to attach them to the start of each source file to most effectively 629 | state the exclusion of warranty; and each file should have at least 630 | the "copyright" line and a pointer to where the full notice is found. 631 | 632 | 633 | Copyright (C) 634 | 635 | This program is free software: you can redistribute it and/or modify 636 | it under the terms of the GNU Affero General Public License as published by 637 | the Free Software Foundation, either version 3 of the License, or 638 | (at your option) any later version. 639 | 640 | This program is distributed in the hope that it will be useful, 641 | but WITHOUT ANY WARRANTY; without even the implied warranty of 642 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 643 | GNU Affero General Public License for more details. 644 | 645 | You should have received a copy of the GNU Affero General Public License 646 | along with this program. If not, see . 647 | 648 | Also add information on how to contact you by electronic and paper mail. 649 | 650 | If your software can interact with users remotely through a computer 651 | network, you should also make sure that it provides a way for users to 652 | get its source. For example, if your program is a web application, its 653 | interface could display a "Source" link that leads users to an archive 654 | of the code. There are many ways you could offer source, and different 655 | solutions will be better for different programs; see section 13 for the 656 | specific requirements. 657 | 658 | You should also get your employer (if you work as a programmer) or school, 659 | if any, to sign a "copyright disclaimer" for the program, if necessary. 660 | For more information on this, and how to apply and follow the GNU AGPL, see 661 | . 662 | --------------------------------------------------------------------------------