diff --git a/.github/notifications.sh b/.github/notifications.sh new file mode 100755 index 00000000..ecbecb36 --- /dev/null +++ b/.github/notifications.sh @@ -0,0 +1,7 @@ +#!/bin/bash + +# Takes two text arguments +# Message Format: : + +[[ -z ${WEBHOOK_URL} ]] && exit 0 +curl -X POST -H 'Content-type: application/json' --data "{\"text\":\"${1}: ${2}\"}" "${WEBHOOK_URL}" diff --git a/.github/setup.sh b/.github/setup.sh new file mode 100644 index 00000000..874e78aa --- /dev/null +++ b/.github/setup.sh @@ -0,0 +1,13 @@ +#!/bin/bash + +main() { + BRANCH_OR_TAG="$(echo "${GITHUB_REF}" | sed 's/refs\/heads\///g' | sed 's/refs\/tags\///g')" + PROJECT_NAME="ansible-workbench" + echo "BRANCH_OR_TAG=${BRANCH_OR_TAG}" >> $GITHUB_ENV + echo "WEBHOOK_URL=${WEBHOOK_URL}" >> $GITHUB_ENV + echo "PROJECT_NAME=${PROJECT_NAME}" >> $GITHUB_ENV + echo "NOTIFICATION=${PROJECT_NAME} [${BRANCH_OR_TAG}]" >> $GITHUB_ENV + echo "USERNAME=shared-vision-solutions" >> $GITHUB_ENV +} + +main diff --git a/.github/template.sh b/.github/template.sh new file mode 100644 index 00000000..8990f55b --- /dev/null +++ b/.github/template.sh @@ -0,0 +1,13 @@ +#!/bin/bash + +NAME=${1:-"Pro Buddy Dev"} +EMAIL=${2:-"somedude@coolstartup.com"} + +main() { + pip install cookiecutter poetry + git config --global user.name "${NAME}" + git config --global user.email "${EMAIL}" + echo -e '\n\n\n\n\n\n\n' | cookiecutter template/ +} + +main diff --git a/.github/workflows/self-test.yml b/.github/workflows/self-test.yml new file mode 100644 index 00000000..ce861e53 --- /dev/null +++ b/.github/workflows/self-test.yml @@ -0,0 +1,229 @@ +name: ansible-workbench-self-test + +# Required Github Repository Secrets: +# REMOTE_TOKEN - Github Token With Access To This Repo +# REMOTE_ORIGIN - The git remote repository name (organization/repo) +# SLACK_WEBHOOK - The slack webhook for build notifications + +on: + push: + schedule: + - cron: "0 6 * * 1" + workflow_dispatch: + +jobs: + + documentation_test: + + runs-on: ubuntu-20.04 + strategy: + max-parallel: 4 + matrix: + python-version: [ 3.7 ] + + steps: + + - uses: actions/checkout@v2 + with: + path: 'template' + - name: Setup Environment + run: | + source ./template/.github/setup.sh + env: + WEBHOOK_URL: ${{ secrets.SLACK_WEBHOOK }} + + - name: Set up Python ${{ matrix.python-version }} + uses: actions/setup-python@v1 + with: + python-version: ${{ matrix.python-version }} + - name: Create Template + run: | + source ./template/.github/template.sh + + - name: Check Markdown Links For Readme + uses: gaurav-nelson/github-action-markdown-link-check@1.0.11 + with: + use-quiet-mode: 'no' + use-verbose-mode: 'yes' + folder-path: 'template, template/.github/workflows' + max-depth: 1 + - name: Check Markdown Links For Rendered Template + uses: gaurav-nelson/github-action-markdown-link-check@1.0.11 + with: + use-quiet-mode: 'no' + use-verbose-mode: 'yes' + folder-path: './flower_generator' + max-depth: -1 + + - name: Report Job Status on Success + run: | + ./template/.github/notifications.sh "${NOTIFICATION}" "documentation checks succeeded!" + - name: Report Job Status on Failure + if: failure() + run: | + ./template/.github/notifications.sh "${NOTIFICATION}" "documentation checks failed!" + + linting: + + runs-on: ubuntu-20.04 + strategy: + max-parallel: 4 + matrix: + python-version: [3.7] + + steps: + + - uses: actions/checkout@v2 + with: + path: 'template' + - name: Setup Environment + run: | + source ./template/.github/setup.sh + env: + WEBHOOK_URL: ${{ secrets.SLACK_WEBHOOK }} + + - name: Set up Python ${{ matrix.python-version }} + uses: actions/setup-python@v1 + with: + python-version: ${{ matrix.python-version }} + - name: Create Template + run: | + source ./template/.github/template.sh + + - name: Lint Role Defaults + run: | + cd flower_generator + poetry run molecule lint + + - name: Report Job Status on Success + run: | + ./template/.github/notifications.sh "${NOTIFICATION}" "linting checks succeeded!" + - name: Report Job Status on Failure + if: failure() + run: | + ./template/.github/notifications.sh "${NOTIFICATION}" "linting checks failed!" + + push_repository_test: + needs: [linting, documentation_test] + + runs-on: ubuntu-20.04 + strategy: + max-parallel: 4 + matrix: + python-version: [3.7] + + steps: + + - uses: actions/checkout@v2 + with: + path: 'template' + persist-credentials: false + - name: Setup Environment + run: | + source ./template/.github/setup.sh "GitHub Action" "action@github.com" + env: + WEBHOOK_URL: ${{ secrets.SLACK_WEBHOOK }} + + - name: Set up Python ${{ matrix.python-version }} + uses: actions/setup-python@v1 + with: + python-version: ${{ matrix.python-version }} + - name: Create Template + run: | + source ./template/.github/template.sh + + - name: Clean Up Tags for Git Push + run: | + cd flower_generator + git checkout master + git tag --delete v0.0.0 # Don't Repush + git tag v1.0.0 + - name: Push To Test Repository (master) + uses: ad-m/github-push-action@v0.6.0 + with: + github_token: ${{ secrets.REMOTE_TOKEN }} + branch: master + tags: false + directory: flower_generator + repository: ${{ secrets.REMOTE_ORIGIN }} + force: true + - name: Push To Test Repository (production) + uses: ad-m/github-push-action@v0.6.0 + with: + github_token: ${{ secrets.REMOTE_TOKEN }} + branch: production + tags: false + directory: flower_generator + repository: ${{ secrets.REMOTE_ORIGIN }} + force: true + - name: Push To Test Repository (release tag) + uses: ad-m/github-push-action@v0.6.0 + with: + github_token: ${{ secrets.REMOTE_TOKEN }} + branch: production + tags: true + directory: flower_generator + repository: ${{ secrets.REMOTE_ORIGIN }} + force: true + + - name: Report Job Status on Success + run: | + ./template/.github/notifications.sh "${NOTIFICATION}" "push has been triggered!" + - name: Report Job Status on Failure + if: failure() + run: | + ./template/.github/notifications.sh "${NOTIFICATION}" "push failed to trigger!" + + create_releases: + needs: [push_repository_test] + + runs-on: ubuntu-20.04 + strategy: + max-parallel: 4 + matrix: + python-version: [ 3.7 ] + + steps: + - uses: actions/checkout@v1 + - name: Setup Environment + if: contains(github.ref, '/tags/v') + run: | + source .github/setup.sh + env: + WEBHOOK_URL: ${{ secrets.SLACK_WEBHOOK }} + + - name: Releases -- Prepare Release Content + if: contains(github.ref, '/tags/v') + run: | + echo "{}" > package.json + - name: Production -- Generate Changelog + if: contains(github.ref, '/tags/v') + uses: scottbrenner/generate-changelog-action@1.0.3 + id: Changelog + env: + REPO: ${{ github.repository }} + - name: Production -- Create Release + if: contains(github.ref, '/tags/v') + uses: actions/create-release@v1 + env: + GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} + with: + tag_name: ${{ env.BRANCH_OR_TAG }} + release_name: Release ${{ env.BRANCH_OR_TAG }} + body: | + ${{ steps.Changelog.outputs.changelog }} + ## Deployment Checklist + - [ ] Ensure correct version is notated + - [ ] Ensure documentation is accurate + - [ ] Ensure self test passes + draft: true + prerelease: false + + - name: Report Job Status on Success + if: contains(github.ref, '/tags/v') + run: | + .github/notifications.sh "${NOTIFICATION}" "automated release has been created!" + - name: Report Job Status on Failure + if: failure() + run: | + .github/notifications.sh "${NOTIFICATION}" "automated release has failed!" diff --git a/.gitignore b/.gitignore new file mode 100644 index 00000000..a0603346 --- /dev/null +++ b/.gitignore @@ -0,0 +1,3 @@ +.txt +.cache +poetry.lock diff --git a/LICENSE b/LICENSE new file mode 100644 index 00000000..a612ad98 --- /dev/null +++ b/LICENSE @@ -0,0 +1,373 @@ +Mozilla Public License Version 2.0 +================================== + +1. Definitions +-------------- + +1.1. "Contributor" + means each individual or legal entity that creates, contributes to + the creation of, or owns Covered Software. + +1.2. "Contributor Version" + means the combination of the Contributions of others (if any) used + by a Contributor and that particular Contributor's Contribution. + +1.3. "Contribution" + means Covered Software of a particular Contributor. + +1.4. "Covered Software" + means Source Code Form to which the initial Contributor has attached + the notice in Exhibit A, the Executable Form of such Source Code + Form, and Modifications of such Source Code Form, in each case + including portions thereof. + +1.5. "Incompatible With Secondary Licenses" + means + + (a) that the initial Contributor has attached the notice described + in Exhibit B to the Covered Software; or + + (b) that the Covered Software was made available under the terms of + version 1.1 or earlier of the License, but not also under the + terms of a Secondary License. + +1.6. "Executable Form" + means any form of the work other than Source Code Form. + +1.7. "Larger Work" + means a work that combines Covered Software with other material, in + a separate file or files, that is not Covered Software. + +1.8. "License" + means this document. + +1.9. "Licensable" + means having the right to grant, to the maximum extent possible, + whether at the time of the initial grant or subsequently, any and + all of the rights conveyed by this License. + +1.10. "Modifications" + means any of the following: + + (a) any file in Source Code Form that results from an addition to, + deletion from, or modification of the contents of Covered + Software; or + + (b) any new file in Source Code Form that contains any Covered + Software. + +1.11. "Patent Claims" of a Contributor + means any patent claim(s), including without limitation, method, + process, and apparatus claims, in any patent Licensable by such + Contributor that would be infringed, but for the grant of the + License, by the making, using, selling, offering for sale, having + made, import, or transfer of either its Contributions or its + Contributor Version. + +1.12. "Secondary License" + means either the GNU General Public License, Version 2.0, the GNU + Lesser General Public License, Version 2.1, the GNU Affero General + Public License, Version 3.0, or any later versions of those + licenses. + +1.13. "Source Code Form" + means the form of the work preferred for making modifications. + +1.14. "You" (or "Your") + means an individual or a legal entity exercising rights under this + License. For legal entities, "You" includes any entity that + controls, is controlled by, or is under common control with You. For + purposes of this definition, "control" means (a) the power, direct + or indirect, to cause the direction or management of such entity, + whether by contract or otherwise, or (b) ownership of more than + fifty percent (50%) of the outstanding shares or beneficial + ownership of such entity. + +2. License Grants and Conditions +-------------------------------- + +2.1. Grants + +Each Contributor hereby grants You a world-wide, royalty-free, +non-exclusive license: + +(a) under intellectual property rights (other than patent or trademark) + Licensable by such Contributor to use, reproduce, make available, + modify, display, perform, distribute, and otherwise exploit its + Contributions, either on an unmodified basis, with Modifications, or + as part of a Larger Work; and + +(b) under Patent Claims of such Contributor to make, use, sell, offer + for sale, have made, import, and otherwise transfer either its + Contributions or its Contributor Version. + +2.2. Effective Date + +The licenses granted in Section 2.1 with respect to any Contribution +become effective for each Contribution on the date the Contributor first +distributes such Contribution. + +2.3. Limitations on Grant Scope + +The licenses granted in this Section 2 are the only rights granted under +this License. No additional rights or licenses will be implied from the +distribution or licensing of Covered Software under this License. +Notwithstanding Section 2.1(b) above, no patent license is granted by a +Contributor: + +(a) for any code that a Contributor has removed from Covered Software; + or + +(b) for infringements caused by: (i) Your and any other third party's + modifications of Covered Software, or (ii) the combination of its + Contributions with other software (except as part of its Contributor + Version); or + +(c) under Patent Claims infringed by Covered Software in the absence of + its Contributions. + +This License does not grant any rights in the trademarks, service marks, +or logos of any Contributor (except as may be necessary to comply with +the notice requirements in Section 3.4). + +2.4. Subsequent Licenses + +No Contributor makes additional grants as a result of Your choice to +distribute the Covered Software under a subsequent version of this +License (see Section 10.2) or under the terms of a Secondary License (if +permitted under the terms of Section 3.3). + +2.5. Representation + +Each Contributor represents that the Contributor believes its +Contributions are its original creation(s) or it has sufficient rights +to grant the rights to its Contributions conveyed by this License. + +2.6. Fair Use + +This License is not intended to limit any rights You have under +applicable copyright doctrines of fair use, fair dealing, or other +equivalents. + +2.7. Conditions + +Sections 3.1, 3.2, 3.3, and 3.4 are conditions of the licenses granted +in Section 2.1. + +3. Responsibilities +------------------- + +3.1. Distribution of Source Form + +All distribution of Covered Software in Source Code Form, including any +Modifications that You create or to which You contribute, must be under +the terms of this License. You must inform recipients that the Source +Code Form of the Covered Software is governed by the terms of this +License, and how they can obtain a copy of this License. You may not +attempt to alter or restrict the recipients' rights in the Source Code +Form. + +3.2. Distribution of Executable Form + +If You distribute Covered Software in Executable Form then: + +(a) such Covered Software must also be made available in Source Code + Form, as described in Section 3.1, and You must inform recipients of + the Executable Form how they can obtain a copy of such Source Code + Form by reasonable means in a timely manner, at a charge no more + than the cost of distribution to the recipient; and + +(b) You may distribute such Executable Form under the terms of this + License, or sublicense it under different terms, provided that the + license for the Executable Form does not attempt to limit or alter + the recipients' rights in the Source Code Form under this License. + +3.3. Distribution of a Larger Work + +You may create and distribute a Larger Work under terms of Your choice, +provided that You also comply with the requirements of this License for +the Covered Software. If the Larger Work is a combination of Covered +Software with a work governed by one or more Secondary Licenses, and the +Covered Software is not Incompatible With Secondary Licenses, this +License permits You to additionally distribute such Covered Software +under the terms of such Secondary License(s), so that the recipient of +the Larger Work may, at their option, further distribute the Covered +Software under the terms of either this License or such Secondary +License(s). + +3.4. Notices + +You may not remove or alter the substance of any license notices +(including copyright notices, patent notices, disclaimers of warranty, +or limitations of liability) contained within the Source Code Form of +the Covered Software, except that You may alter any license notices to +the extent required to remedy known factual inaccuracies. + +3.5. Application of Additional Terms + +You may choose to offer, and to charge a fee for, warranty, support, +indemnity or liability obligations to one or more recipients of Covered +Software. However, You may do so only on Your own behalf, and not on +behalf of any Contributor. You must make it absolutely clear that any +such warranty, support, indemnity, or liability obligation is offered by +You alone, and You hereby agree to indemnify every Contributor for any +liability incurred by such Contributor as a result of warranty, support, +indemnity or liability terms You offer. You may include additional +disclaimers of warranty and limitations of liability specific to any +jurisdiction. + +4. Inability to Comply Due to Statute or Regulation +--------------------------------------------------- + +If it is impossible for You to comply with any of the terms of this +License with respect to some or all of the Covered Software due to +statute, judicial order, or regulation then You must: (a) comply with +the terms of this License to the maximum extent possible; and (b) +describe the limitations and the code they affect. Such description must +be placed in a text file included with all distributions of the Covered +Software under this License. Except to the extent prohibited by statute +or regulation, such description must be sufficiently detailed for a +recipient of ordinary skill to be able to understand it. + +5. Termination +-------------- + +5.1. The rights granted under this License will terminate automatically +if You fail to comply with any of its terms. However, if You become +compliant, then the rights granted under this License from a particular +Contributor are reinstated (a) provisionally, unless and until such +Contributor explicitly and finally terminates Your grants, and (b) on an +ongoing basis, if such Contributor fails to notify You of the +non-compliance by some reasonable means prior to 60 days after You have +come back into compliance. Moreover, Your grants from a particular +Contributor are reinstated on an ongoing basis if such Contributor +notifies You of the non-compliance by some reasonable means, this is the +first time You have received notice of non-compliance with this License +from such Contributor, and You become compliant prior to 30 days after +Your receipt of the notice. + +5.2. If You initiate litigation against any entity by asserting a patent +infringement claim (excluding declaratory judgment actions, +counter-claims, and cross-claims) alleging that a Contributor Version +directly or indirectly infringes any patent, then the rights granted to +You by any and all Contributors for the Covered Software under Section +2.1 of this License shall terminate. + +5.3. In the event of termination under Sections 5.1 or 5.2 above, all +end user license agreements (excluding distributors and resellers) which +have been validly granted by You or Your distributors under this License +prior to termination shall survive termination. + +************************************************************************ +* * +* 6. Disclaimer of Warranty * +* ------------------------- * +* * +* Covered Software is provided under this License on an "as is" * +* basis, without warranty of any kind, either expressed, implied, or * +* statutory, including, without limitation, warranties that the * +* Covered Software is free of defects, merchantable, fit for a * +* particular purpose or non-infringing. The entire risk as to the * +* quality and performance of the Covered Software is with You. * +* Should any Covered Software prove defective in any respect, You * +* (not any Contributor) assume the cost of any necessary servicing, * +* repair, or correction. This disclaimer of warranty constitutes an * +* essential part of this License. No use of any Covered Software is * +* authorized under this License except under this disclaimer. * +* * +************************************************************************ + +************************************************************************ +* * +* 7. Limitation of Liability * +* -------------------------- * +* * +* Under no circumstances and under no legal theory, whether tort * +* (including negligence), contract, or otherwise, shall any * +* Contributor, or anyone who distributes Covered Software as * +* permitted above, be liable to You for any direct, indirect, * +* special, incidental, or consequential damages of any character * +* including, without limitation, damages for lost profits, loss of * +* goodwill, work stoppage, computer failure or malfunction, or any * +* and all other commercial damages or losses, even if such party * +* shall have been informed of the possibility of such damages. This * +* limitation of liability shall not apply to liability for death or * +* personal injury resulting from such party's negligence to the * +* extent applicable law prohibits such limitation. Some * +* jurisdictions do not allow the exclusion or limitation of * +* incidental or consequential damages, so this exclusion and * +* limitation may not apply to You. * +* * +************************************************************************ + +8. Litigation +------------- + +Any litigation relating to this License may be brought only in the +courts of a jurisdiction where the defendant maintains its principal +place of business and such litigation shall be governed by laws of that +jurisdiction, without reference to its conflict-of-law provisions. +Nothing in this Section shall prevent a party's ability to bring +cross-claims or counter-claims. + +9. Miscellaneous +---------------- + +This License represents the complete agreement concerning the subject +matter hereof. If any provision of this License is held to be +unenforceable, such provision shall be reformed only to the extent +necessary to make it enforceable. Any law or regulation which provides +that the language of a contract shall be construed against the drafter +shall not be used to construe this License against a Contributor. + +10. Versions of the License +--------------------------- + +10.1. New Versions + +Mozilla Foundation is the license steward. Except as provided in Section +10.3, no one other than the license steward has the right to modify or +publish new versions of this License. Each version will be given a +distinguishing version number. + +10.2. Effect of New Versions + +You may distribute the Covered Software under the terms of the version +of the License under which You originally received the Covered Software, +or under the terms of any subsequent version published by the license +steward. + +10.3. Modified Versions + +If you create software not governed by this License, and you want to +create a new license for such software, you may create and use a +modified version of this License if you rename the license and remove +any references to the name of the license steward (except to note that +such modified license differs from this License). + +10.4. Distributing Source Code Form that is Incompatible With Secondary +Licenses + +If You choose to distribute Source Code Form that is Incompatible With +Secondary Licenses under the terms of this version of the License, the +notice described in Exhibit B of this License must be attached. + +Exhibit A - Source Code Form License Notice +------------------------------------------- + + This Source Code Form is subject to the terms of the Mozilla Public + License, v. 2.0. If a copy of the MPL was not distributed with this + file, You can obtain one at http://mozilla.org/MPL/2.0/. + +If it is not possible or desirable to put the notice in a particular +file, then You may include the notice in a location (such as a LICENSE +file in a relevant directory) where a recipient would be likely to look +for such a notice. + +You may add additional accurate notices of copyright ownership. + +Exhibit B - "Incompatible With Secondary Licenses" Notice +--------------------------------------------------------- + + This Source Code Form is "Incompatible With Secondary Licenses", as + defined by the Mozilla Public License, v. 2.0. diff --git a/README.md b/README.md new file mode 100644 index 00000000..caa9b035 --- /dev/null +++ b/README.md @@ -0,0 +1,61 @@ +# Ansible Workbench + +Ansible Role Development Enviroment. + +(Please see the [cookiecutter documentation](https://cookiecutter.readthedocs.io/) for instructions on how to use this project template.) + +##### Master Branch: +[![ansible-workbench-self-test](https://github.com/shared-vision-solutions/ansible-workbench/workflows/ansible-workbench-self-test/badge.svg?branch=master)](https://github.com/shared-vision-solutions/ansible-workbench/actions) + +##### Production Branch: +[![ansible-workbench-self-test](https://github.com/shared-vision-solutions/ansible-workbench/workflows/ansible-workbench-self-test/badge.svg?branch=production)](https://github.com/shared-vision-solutions/ansible-workbench/actions) + +## About + +This template generates a development environment for Ansible Roles with a functional CI/CD template for both Travis CI and Github. + +## Getting Started + +- `pip install cookiecutter` +- `cookiecutter https://github.com/shared-vision-solutions/ansible-workbench.git --checkout v0.1.0` + +Give your project a name, and populate the other required template inputs. + +Once the templating is finished: +- `cd ` +- `poetry shell` (to interact with ansible and molecule inside a virtualenv) + +A `master` branch will be created, allowing you to manage a separate `production` branch in [gitlabflow](https://docs.gitlab.com/ee/topics/gitlab_flow.html) style. + +## License + +[MPL-2](LICENSE) + +## Adding / Removing Dependencies For Your Project + +#### Python Dependencies: + +Use the [pyproject.toml](./{{cookiecutter.project_slug}}/pyproject.toml) file to store your project dependencies in accordance with [PEP 518](https://www.python.org/dev/peps/pep-0518/) and [Poetry Dependency Management](https://python-poetry.org/docs/pyproject/#dependencies-and-dev-dependencies). + +Poetry is leverage to manage the Python dependencies: +- [Adding Python Packages with Poetry](https://python-poetry.org/docs/cli/#add) +- [Removing Python Packages With Poetry](https://python-poetry.org/docs/cli/#remove) + +## Default Installed Python Packages: +| package | Description | +| ------------ | -------------------------------------------- | +| ansible | Simple, agentless IT automation | +| ansible-lint | Checks playbooks for practices and behaviour | +| commitizen | Standardizes commit messages | +| poetry | Python package manager | +| molecule | Ansible test framework | +| yamllint | Lints yaml configuration files | + +## Third Party Integrations + +Integrations with the following third party services are configured during templating: + +- [Github Workflows](https://docs.github.com/en/free-pro-team@latest/actions/reference/workflow-syntax-for-github-actions) + - [workflows](./{{cookiecutter.project_slug}}/.github/workflows) +- [TravisCI](https://travis-ci.com/) + - [.travis.yml](./{{cookiecutter.project_slug}}/.travis.yml) diff --git a/cookiecutter.json b/cookiecutter.json new file mode 100644 index 00000000..aa77dfcd --- /dev/null +++ b/cookiecutter.json @@ -0,0 +1,9 @@ +{ + "project_name": "Flower Generator", + "project_slug": "{{ cookiecutter.project_name.lower().replace(' ', '_').replace('-', '_') }}", + "description": "Not the baking kind.", + "author": "Niall Byrne", + "company": "Shared Vision Solutions", + "email": "niall@niallbyrne.ca", + "github_handle": "niall-byrne" +} diff --git a/hooks/post_gen_project.sh b/hooks/post_gen_project.sh new file mode 100644 index 00000000..304b61a1 --- /dev/null +++ b/hooks/post_gen_project.sh @@ -0,0 +1,10 @@ +#!/bin/bash + +git init +git checkout -b master +git stage . +git commit -m "build(Cookiecutter): Initial Generation" +git symbolic-ref HEAD refs/heads/master +git tag v0.0.0 +mkdir -p files templates +poetry install diff --git a/{{cookiecutter.project_slug}}/.ansible-lint b/{{cookiecutter.project_slug}}/.ansible-lint new file mode 100644 index 00000000..f4b9a17c --- /dev/null +++ b/{{cookiecutter.project_slug}}/.ansible-lint @@ -0,0 +1,2 @@ +# .ansible-lint +skip_list: [] diff --git a/{{cookiecutter.project_slug}}/.github/notifications.sh b/{{cookiecutter.project_slug}}/.github/notifications.sh new file mode 100755 index 00000000..ecbecb36 --- /dev/null +++ b/{{cookiecutter.project_slug}}/.github/notifications.sh @@ -0,0 +1,7 @@ +#!/bin/bash + +# Takes two text arguments +# Message Format: : + +[[ -z ${WEBHOOK_URL} ]] && exit 0 +curl -X POST -H 'Content-type: application/json' --data "{\"text\":\"${1}: ${2}\"}" "${WEBHOOK_URL}" diff --git a/{{cookiecutter.project_slug}}/.github/workflows/push.yml b/{{cookiecutter.project_slug}}/.github/workflows/push.yml new file mode 100644 index 00000000..fbfb344c --- /dev/null +++ b/{{cookiecutter.project_slug}}/.github/workflows/push.yml @@ -0,0 +1,83 @@ +name: {{ cookiecutter.project_slug }}-pushes + +# Workflow Secrets: +# SLACK_WEBHOOK (Required, for slack notifications...) + +on: + push: + workflow_dispatch: + +jobs: + + push: + runs-on: ubuntu-20.04 + steps: + + - name: Setup Environment + run: | + BRANCH_OR_TAG="$(echo "${GITHUB_REF}" | sed 's/refs\/heads\///g' | sed 's/refs\/tags\///g')" + PROJECT_NAME="{{ cookiecutter.project_slug }}" + echo "BRANCH_OR_TAG=${BRANCH_OR_TAG}" >> $GITHUB_ENV + echo "WEBHOOK_URL=${WEBHOOK_URL}" >> $GITHUB_ENV + echo "PROJECT_NAME=${PROJECT_NAME}" >> $GITHUB_ENV + echo "NOTIFICATION=${PROJECT_NAME} [${BRANCH_OR_TAG}]" >> $GITHUB_ENV + echo "USERNAME={{ cookiecutter.github_handle }}" >> $GITHUB_ENV{% raw %} + env: + WEBHOOK_URL: ${{ secrets.SLACK_WEBHOOK }} + - uses: actions/checkout@v2 + with: + fetch-depth: 0 + + - name: Install Requirements + run: | + pip install poetry + poetry install + + - name: Run Linter + run: | + poetry run molecule lint + - name: Run docker1 Scenario + run: | + poetry run molecule test -s docker1 + + - name: Report Job Status (Success) + run: | + ./.github/notifications.sh "${NOTIFICATION}" "build was successful!" + - name: Report Job Status + if: failure() + run: | + ./.github/notifications.sh "${NOTIFICATION}" "build has failed!" + + - name: Prepare Release Content + if: contains(github.ref, '/tags/v') + run: | + NEWTAG=${BRANCH_OR_TAG} + echo "NEWTAG=${NEWTAG}" >> $GITHUB_ENV + echo "{}" > package.json + - name: Generate Changelog + if: contains(github.ref, '/tags/v') + uses: scottbrenner/generate-changelog-action@1.0.3 + id: Changelog + env: + REPO: ${{ github.repository }} + - name: Create Release + if: contains(github.ref, '/tags/v') + uses: actions/create-release@v1 + env: + GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} + with: + tag_name: ${{ env.NEWTAG }} + release_name: Release ${{ env.NEWTAG }} + body: | + ${{ steps.Changelog.outputs.changelog }} + draft: true + prerelease: false + - name: Production -- Report Success + if: contains(github.ref, '/tags/v') + run: | + ./.github/notifications.sh "${NOTIFICATION}" "automated release has been created: https://github.com/${USERNAME}/${PROJECT_NAME}/releases" + - name: Production -- Report Failure + if: failure() && contains(github.ref, '/tags/v') + run: | + ./.github/notifications.sh "${NOTIFICATION}" "automated release generation failed!" +{% endraw %} \ No newline at end of file diff --git a/{{cookiecutter.project_slug}}/.github/workflows/release.yml b/{{cookiecutter.project_slug}}/.github/workflows/release.yml new file mode 100644 index 00000000..542ffa35 --- /dev/null +++ b/{{cookiecutter.project_slug}}/.github/workflows/release.yml @@ -0,0 +1,61 @@ +name: {{ cookiecutter.project_slug }}-releases + +# Workflow Secrets: +# SLACK_WEBHOOK (Required, for slack notifications...) +# GALAXY_API_KEY (Required, for Ansible Galaxy Import...) + +on: + release: + types: [published] + workflow_dispatch: + inputs: + TAG: + description: 'Tag to Deploy' + required: true + default: '' + +jobs: + release: + runs-on: ubuntu-20.04 + + steps: + - name: Setup Environment + run: | + BRANCH_OR_TAG="$(echo "${GITHUB_REF}" | sed 's/refs\/heads\///g' | sed 's/refs\/tags\///g')" + PROJECT_NAME="{{ cookiecutter.project_slug }}" + echo "BRANCH_OR_TAG=${BRANCH_OR_TAG}" >> $GITHUB_ENV + echo "WEBHOOK_URL=${WEBHOOK_URL}" >> $GITHUB_ENV + echo "PROJECT_NAME=${PROJECT_NAME}" >> $GITHUB_ENV + echo "NOTIFICATION=${PROJECT_NAME} [${BRANCH_OR_TAG}]" >> $GITHUB_ENV + echo "USERNAME={{ cookiecutter.github_handle }}" >> $GITHUB_ENV{% raw %} + env: + WEBHOOK_URL: ${{ secrets.SLACK_WEBHOOK }} + - name: Code Checkout (workflow dispatch) + if: github.event_name == 'workflow_dispatch' + uses: actions/checkout@v2 + with: + fetch-depth: 0 + ref: ${{ github.event.inputs.TAG }} + - name: Code Checkout (published release) + if: github.event_name != 'workflow_dispatch' + uses: actions/checkout@v2 + with: + fetch-depth: 0 + + - name: Install Requirements + run: | + pip install poetry + poetry install + - name: Trigger Ansible Galaxy Import + run: | + ansible-galaxy role import ${USERNAME} ${PROJECT_NAME} --token ${API_KEY} + env: + API_KEY: ${{ secrets.GALAXY_API_KEY }} + - name: Production -- Report Success + run: | + ./.github/notifications.sh "${NOTIFICATION}" "automated galaxy import has been completed!" + - name: Production -- Report Failure + if: failure() + run: | + ./.github/notifications.sh "${NOTIFICATION}" "automated galaxy import has failed!" +{% endraw %} \ No newline at end of file diff --git a/{{cookiecutter.project_slug}}/.gitignore b/{{cookiecutter.project_slug}}/.gitignore new file mode 100644 index 00000000..a0603346 --- /dev/null +++ b/{{cookiecutter.project_slug}}/.gitignore @@ -0,0 +1,3 @@ +.txt +.cache +poetry.lock diff --git a/{{cookiecutter.project_slug}}/.travis.yml b/{{cookiecutter.project_slug}}/.travis.yml new file mode 100644 index 00000000..1d78ced0 --- /dev/null +++ b/{{cookiecutter.project_slug}}/.travis.yml @@ -0,0 +1,15 @@ +sudo: required +language: bash +jobs: + include: + - os: osx + osx_image: xcode12.5 + env: + - SCENARIO=hostmachine1 +before_install: [] +install: +- sudo python3 -m pip install poetry +- poetry install +script: +- poetry run molecule lint +- poetry run molecule test -s "${SCENARIO}" diff --git a/{{cookiecutter.project_slug}}/.yamllint b/{{cookiecutter.project_slug}}/.yamllint new file mode 100644 index 00000000..88276760 --- /dev/null +++ b/{{cookiecutter.project_slug}}/.yamllint @@ -0,0 +1,33 @@ +--- +# Based on ansible-lint config +extends: default + +rules: + braces: + max-spaces-inside: 1 + level: error + brackets: + max-spaces-inside: 1 + level: error + colons: + max-spaces-after: -1 + level: error + commas: + max-spaces-after: -1 + level: error + comments: disable + comments-indentation: disable + document-start: disable + empty-lines: + max: 3 + level: error + hyphens: + level: error + indentation: disable + key-duplicates: enable + line-length: disable + new-line-at-end-of-file: disable + new-lines: + type: unix + trailing-spaces: disable + truthy: disable diff --git a/{{cookiecutter.project_slug}}/LICENSE b/{{cookiecutter.project_slug}}/LICENSE new file mode 100644 index 00000000..a612ad98 --- /dev/null +++ b/{{cookiecutter.project_slug}}/LICENSE @@ -0,0 +1,373 @@ +Mozilla Public License Version 2.0 +================================== + +1. Definitions +-------------- + +1.1. "Contributor" + means each individual or legal entity that creates, contributes to + the creation of, or owns Covered Software. + +1.2. "Contributor Version" + means the combination of the Contributions of others (if any) used + by a Contributor and that particular Contributor's Contribution. + +1.3. "Contribution" + means Covered Software of a particular Contributor. + +1.4. "Covered Software" + means Source Code Form to which the initial Contributor has attached + the notice in Exhibit A, the Executable Form of such Source Code + Form, and Modifications of such Source Code Form, in each case + including portions thereof. + +1.5. "Incompatible With Secondary Licenses" + means + + (a) that the initial Contributor has attached the notice described + in Exhibit B to the Covered Software; or + + (b) that the Covered Software was made available under the terms of + version 1.1 or earlier of the License, but not also under the + terms of a Secondary License. + +1.6. "Executable Form" + means any form of the work other than Source Code Form. + +1.7. "Larger Work" + means a work that combines Covered Software with other material, in + a separate file or files, that is not Covered Software. + +1.8. "License" + means this document. + +1.9. "Licensable" + means having the right to grant, to the maximum extent possible, + whether at the time of the initial grant or subsequently, any and + all of the rights conveyed by this License. + +1.10. "Modifications" + means any of the following: + + (a) any file in Source Code Form that results from an addition to, + deletion from, or modification of the contents of Covered + Software; or + + (b) any new file in Source Code Form that contains any Covered + Software. + +1.11. "Patent Claims" of a Contributor + means any patent claim(s), including without limitation, method, + process, and apparatus claims, in any patent Licensable by such + Contributor that would be infringed, but for the grant of the + License, by the making, using, selling, offering for sale, having + made, import, or transfer of either its Contributions or its + Contributor Version. + +1.12. "Secondary License" + means either the GNU General Public License, Version 2.0, the GNU + Lesser General Public License, Version 2.1, the GNU Affero General + Public License, Version 3.0, or any later versions of those + licenses. + +1.13. "Source Code Form" + means the form of the work preferred for making modifications. + +1.14. "You" (or "Your") + means an individual or a legal entity exercising rights under this + License. For legal entities, "You" includes any entity that + controls, is controlled by, or is under common control with You. For + purposes of this definition, "control" means (a) the power, direct + or indirect, to cause the direction or management of such entity, + whether by contract or otherwise, or (b) ownership of more than + fifty percent (50%) of the outstanding shares or beneficial + ownership of such entity. + +2. License Grants and Conditions +-------------------------------- + +2.1. Grants + +Each Contributor hereby grants You a world-wide, royalty-free, +non-exclusive license: + +(a) under intellectual property rights (other than patent or trademark) + Licensable by such Contributor to use, reproduce, make available, + modify, display, perform, distribute, and otherwise exploit its + Contributions, either on an unmodified basis, with Modifications, or + as part of a Larger Work; and + +(b) under Patent Claims of such Contributor to make, use, sell, offer + for sale, have made, import, and otherwise transfer either its + Contributions or its Contributor Version. + +2.2. Effective Date + +The licenses granted in Section 2.1 with respect to any Contribution +become effective for each Contribution on the date the Contributor first +distributes such Contribution. + +2.3. Limitations on Grant Scope + +The licenses granted in this Section 2 are the only rights granted under +this License. No additional rights or licenses will be implied from the +distribution or licensing of Covered Software under this License. +Notwithstanding Section 2.1(b) above, no patent license is granted by a +Contributor: + +(a) for any code that a Contributor has removed from Covered Software; + or + +(b) for infringements caused by: (i) Your and any other third party's + modifications of Covered Software, or (ii) the combination of its + Contributions with other software (except as part of its Contributor + Version); or + +(c) under Patent Claims infringed by Covered Software in the absence of + its Contributions. + +This License does not grant any rights in the trademarks, service marks, +or logos of any Contributor (except as may be necessary to comply with +the notice requirements in Section 3.4). + +2.4. Subsequent Licenses + +No Contributor makes additional grants as a result of Your choice to +distribute the Covered Software under a subsequent version of this +License (see Section 10.2) or under the terms of a Secondary License (if +permitted under the terms of Section 3.3). + +2.5. Representation + +Each Contributor represents that the Contributor believes its +Contributions are its original creation(s) or it has sufficient rights +to grant the rights to its Contributions conveyed by this License. + +2.6. Fair Use + +This License is not intended to limit any rights You have under +applicable copyright doctrines of fair use, fair dealing, or other +equivalents. + +2.7. Conditions + +Sections 3.1, 3.2, 3.3, and 3.4 are conditions of the licenses granted +in Section 2.1. + +3. Responsibilities +------------------- + +3.1. Distribution of Source Form + +All distribution of Covered Software in Source Code Form, including any +Modifications that You create or to which You contribute, must be under +the terms of this License. You must inform recipients that the Source +Code Form of the Covered Software is governed by the terms of this +License, and how they can obtain a copy of this License. You may not +attempt to alter or restrict the recipients' rights in the Source Code +Form. + +3.2. Distribution of Executable Form + +If You distribute Covered Software in Executable Form then: + +(a) such Covered Software must also be made available in Source Code + Form, as described in Section 3.1, and You must inform recipients of + the Executable Form how they can obtain a copy of such Source Code + Form by reasonable means in a timely manner, at a charge no more + than the cost of distribution to the recipient; and + +(b) You may distribute such Executable Form under the terms of this + License, or sublicense it under different terms, provided that the + license for the Executable Form does not attempt to limit or alter + the recipients' rights in the Source Code Form under this License. + +3.3. Distribution of a Larger Work + +You may create and distribute a Larger Work under terms of Your choice, +provided that You also comply with the requirements of this License for +the Covered Software. If the Larger Work is a combination of Covered +Software with a work governed by one or more Secondary Licenses, and the +Covered Software is not Incompatible With Secondary Licenses, this +License permits You to additionally distribute such Covered Software +under the terms of such Secondary License(s), so that the recipient of +the Larger Work may, at their option, further distribute the Covered +Software under the terms of either this License or such Secondary +License(s). + +3.4. Notices + +You may not remove or alter the substance of any license notices +(including copyright notices, patent notices, disclaimers of warranty, +or limitations of liability) contained within the Source Code Form of +the Covered Software, except that You may alter any license notices to +the extent required to remedy known factual inaccuracies. + +3.5. Application of Additional Terms + +You may choose to offer, and to charge a fee for, warranty, support, +indemnity or liability obligations to one or more recipients of Covered +Software. However, You may do so only on Your own behalf, and not on +behalf of any Contributor. You must make it absolutely clear that any +such warranty, support, indemnity, or liability obligation is offered by +You alone, and You hereby agree to indemnify every Contributor for any +liability incurred by such Contributor as a result of warranty, support, +indemnity or liability terms You offer. You may include additional +disclaimers of warranty and limitations of liability specific to any +jurisdiction. + +4. Inability to Comply Due to Statute or Regulation +--------------------------------------------------- + +If it is impossible for You to comply with any of the terms of this +License with respect to some or all of the Covered Software due to +statute, judicial order, or regulation then You must: (a) comply with +the terms of this License to the maximum extent possible; and (b) +describe the limitations and the code they affect. Such description must +be placed in a text file included with all distributions of the Covered +Software under this License. Except to the extent prohibited by statute +or regulation, such description must be sufficiently detailed for a +recipient of ordinary skill to be able to understand it. + +5. Termination +-------------- + +5.1. The rights granted under this License will terminate automatically +if You fail to comply with any of its terms. However, if You become +compliant, then the rights granted under this License from a particular +Contributor are reinstated (a) provisionally, unless and until such +Contributor explicitly and finally terminates Your grants, and (b) on an +ongoing basis, if such Contributor fails to notify You of the +non-compliance by some reasonable means prior to 60 days after You have +come back into compliance. Moreover, Your grants from a particular +Contributor are reinstated on an ongoing basis if such Contributor +notifies You of the non-compliance by some reasonable means, this is the +first time You have received notice of non-compliance with this License +from such Contributor, and You become compliant prior to 30 days after +Your receipt of the notice. + +5.2. If You initiate litigation against any entity by asserting a patent +infringement claim (excluding declaratory judgment actions, +counter-claims, and cross-claims) alleging that a Contributor Version +directly or indirectly infringes any patent, then the rights granted to +You by any and all Contributors for the Covered Software under Section +2.1 of this License shall terminate. + +5.3. In the event of termination under Sections 5.1 or 5.2 above, all +end user license agreements (excluding distributors and resellers) which +have been validly granted by You or Your distributors under this License +prior to termination shall survive termination. + +************************************************************************ +* * +* 6. Disclaimer of Warranty * +* ------------------------- * +* * +* Covered Software is provided under this License on an "as is" * +* basis, without warranty of any kind, either expressed, implied, or * +* statutory, including, without limitation, warranties that the * +* Covered Software is free of defects, merchantable, fit for a * +* particular purpose or non-infringing. The entire risk as to the * +* quality and performance of the Covered Software is with You. * +* Should any Covered Software prove defective in any respect, You * +* (not any Contributor) assume the cost of any necessary servicing, * +* repair, or correction. This disclaimer of warranty constitutes an * +* essential part of this License. No use of any Covered Software is * +* authorized under this License except under this disclaimer. * +* * +************************************************************************ + +************************************************************************ +* * +* 7. Limitation of Liability * +* -------------------------- * +* * +* Under no circumstances and under no legal theory, whether tort * +* (including negligence), contract, or otherwise, shall any * +* Contributor, or anyone who distributes Covered Software as * +* permitted above, be liable to You for any direct, indirect, * +* special, incidental, or consequential damages of any character * +* including, without limitation, damages for lost profits, loss of * +* goodwill, work stoppage, computer failure or malfunction, or any * +* and all other commercial damages or losses, even if such party * +* shall have been informed of the possibility of such damages. This * +* limitation of liability shall not apply to liability for death or * +* personal injury resulting from such party's negligence to the * +* extent applicable law prohibits such limitation. Some * +* jurisdictions do not allow the exclusion or limitation of * +* incidental or consequential damages, so this exclusion and * +* limitation may not apply to You. * +* * +************************************************************************ + +8. Litigation +------------- + +Any litigation relating to this License may be brought only in the +courts of a jurisdiction where the defendant maintains its principal +place of business and such litigation shall be governed by laws of that +jurisdiction, without reference to its conflict-of-law provisions. +Nothing in this Section shall prevent a party's ability to bring +cross-claims or counter-claims. + +9. Miscellaneous +---------------- + +This License represents the complete agreement concerning the subject +matter hereof. If any provision of this License is held to be +unenforceable, such provision shall be reformed only to the extent +necessary to make it enforceable. Any law or regulation which provides +that the language of a contract shall be construed against the drafter +shall not be used to construe this License against a Contributor. + +10. Versions of the License +--------------------------- + +10.1. New Versions + +Mozilla Foundation is the license steward. Except as provided in Section +10.3, no one other than the license steward has the right to modify or +publish new versions of this License. Each version will be given a +distinguishing version number. + +10.2. Effect of New Versions + +You may distribute the Covered Software under the terms of the version +of the License under which You originally received the Covered Software, +or under the terms of any subsequent version published by the license +steward. + +10.3. Modified Versions + +If you create software not governed by this License, and you want to +create a new license for such software, you may create and use a +modified version of this License if you rename the license and remove +any references to the name of the license steward (except to note that +such modified license differs from this License). + +10.4. Distributing Source Code Form that is Incompatible With Secondary +Licenses + +If You choose to distribute Source Code Form that is Incompatible With +Secondary Licenses under the terms of this version of the License, the +notice described in Exhibit B of this License must be attached. + +Exhibit A - Source Code Form License Notice +------------------------------------------- + + This Source Code Form is subject to the terms of the Mozilla Public + License, v. 2.0. If a copy of the MPL was not distributed with this + file, You can obtain one at http://mozilla.org/MPL/2.0/. + +If it is not possible or desirable to put the notice in a particular +file, then You may include the notice in a location (such as a LICENSE +file in a relevant directory) where a recipient would be likely to look +for such a notice. + +You may add additional accurate notices of copyright ownership. + +Exhibit B - "Incompatible With Secondary Licenses" Notice +--------------------------------------------------------- + + This Source Code Form is "Incompatible With Secondary Licenses", as + defined by the Mozilla Public License, v. 2.0. diff --git a/{{cookiecutter.project_slug}}/README.md b/{{cookiecutter.project_slug}}/README.md new file mode 100644 index 00000000..eb93ee45 --- /dev/null +++ b/{{cookiecutter.project_slug}}/README.md @@ -0,0 +1,46 @@ +# {{cookiecutter.project_slug}} + +### Master: +- Travis CI: ![TravisCI](https://travis-ci.com/{{cookiecutter.github_handle}}/{{cookiecutter.project_slug}}.svg?branch=master) +- Github Actions: [![role-homebrew-retry](https://github.com/{{cookiecutter.github_handle}}/{{cookiecutter.project_slug}}/actions/workflows/push.yml/badge.svg?branch=master)](https://github.com/{{cookiecutter.github_handle}}/{{cookiecutter.project_slug}}/actions/workflows/push.yml) + +### Production: +- Travis CI: ![TravisCI](https://travis-ci.com/{{cookiecutter.github_handle}}/{{cookiecutter.project_slug}}.svg?branch=production) +- Github Actions: [![role-homebrew-retry](https://github.com/{{cookiecutter.github_handle}}/{{cookiecutter.project_slug}}/actions/workflows/push.yml/badge.svg?branch=production)](https://github.com/{{cookiecutter.github_handle}}/{{cookiecutter.project_slug}}/actions/workflows/push.yml) + +{{ cookiecutter.description }} + +Requirements +------------ + +None + + +Role Variables +-------------- + +None + +Dependencies +------------ + +None + +Example Playbook +---------------- + +Including an example of how to use your role (for instance, with variables passed in as parameters) is always nice for users too: + + - hosts: all + roles: + - { role: {{ cookiecutter.github_handle }}.{{ cookiecutter.project_slug }} } + +License +------- + +MPL-2 + +Author Information +------------------ + +{{ cookiecutter.author }} <{{ cookiecutter.email }}> diff --git a/{{cookiecutter.project_slug}}/defaults/main.yml b/{{cookiecutter.project_slug}}/defaults/main.yml new file mode 100644 index 00000000..e713ac45 --- /dev/null +++ b/{{cookiecutter.project_slug}}/defaults/main.yml @@ -0,0 +1,2 @@ +--- +# defaults file for {{ cookiecutter.project_slug }} diff --git a/{{cookiecutter.project_slug}}/handlers/main.yml b/{{cookiecutter.project_slug}}/handlers/main.yml new file mode 100644 index 00000000..5447d2d3 --- /dev/null +++ b/{{cookiecutter.project_slug}}/handlers/main.yml @@ -0,0 +1,2 @@ +--- +# handlers file for {{ cookiecutter.project_slug }} diff --git a/{{cookiecutter.project_slug}}/meta/main.yml b/{{cookiecutter.project_slug}}/meta/main.yml new file mode 100644 index 00000000..ce1083a6 --- /dev/null +++ b/{{cookiecutter.project_slug}}/meta/main.yml @@ -0,0 +1,18 @@ +--- +galaxy_info: + role_name: {{ cookiecutter.project_slug }} + namespace: {{ cookiecutter.github_handle.lower().replace(' ', '_').replace('-', '_') }} + author: {{ cookiecutter.author }} + description: {{ cookiecutter.description }} + company: {{ cookiecutter.company }} + license: MPL-2 + platforms: + - name: MacOSX + versions: + - '10.15' + - '10.14' + min_ansible_version: 3.3.0 + galaxy_tags: + - osx + +dependencies: [] diff --git a/{{cookiecutter.project_slug}}/molecule/default/molecule.yml b/{{cookiecutter.project_slug}}/molecule/default/molecule.yml new file mode 100644 index 00000000..baca59e9 --- /dev/null +++ b/{{cookiecutter.project_slug}}/molecule/default/molecule.yml @@ -0,0 +1,15 @@ +--- +dependency: + name: galaxy +driver: + name: delegated +platforms: + - name: instance +provisioner: + name: ansible +verifier: + name: ansible +lint: | + set -e + yamllint . + ansible-lint diff --git a/{{cookiecutter.project_slug}}/molecule/docker1/converge.yml b/{{cookiecutter.project_slug}}/molecule/docker1/converge.yml new file mode 100644 index 00000000..654a783f --- /dev/null +++ b/{{cookiecutter.project_slug}}/molecule/docker1/converge.yml @@ -0,0 +1,10 @@ +--- +- name: Converge + hosts: all + connection: local + vars: + test: true + tasks: + - name: "Include {{ cookiecutter.github_handle.lower().replace(' ', '_').replace('-', '_') }}.{{ cookiecutter.project_slug }}" + ansible.builtin.include_role: + name: "{{ cookiecutter.github_handle.lower().replace(' ', '_').replace('-', '_') }}.{{ cookiecutter.project_slug }}" diff --git a/{{cookiecutter.project_slug}}/molecule/docker1/molecule.yml b/{{cookiecutter.project_slug}}/molecule/docker1/molecule.yml new file mode 100644 index 00000000..b5710a8e --- /dev/null +++ b/{{cookiecutter.project_slug}}/molecule/docker1/molecule.yml @@ -0,0 +1,13 @@ +--- +dependency: + name: galaxy +driver: + name: docker +platforms: + - name: instance + image: docker.io/pycontribs/centos:8 + pre_build_image: true +provisioner: + name: ansible +verifier: + name: ansible diff --git a/{{cookiecutter.project_slug}}/molecule/docker1/verify.yml b/{{cookiecutter.project_slug}}/molecule/docker1/verify.yml new file mode 100644 index 00000000..67dbf238 --- /dev/null +++ b/{{cookiecutter.project_slug}}/molecule/docker1/verify.yml @@ -0,0 +1,8 @@ +--- +- name: Verify + hosts: all + gather_facts: false + tasks: + - name: PlaceHolder Task + debug: + msg: "Verification Script." diff --git a/{{cookiecutter.project_slug}}/molecule/hostmachine1/converge.yml b/{{cookiecutter.project_slug}}/molecule/hostmachine1/converge.yml new file mode 100644 index 00000000..654a783f --- /dev/null +++ b/{{cookiecutter.project_slug}}/molecule/hostmachine1/converge.yml @@ -0,0 +1,10 @@ +--- +- name: Converge + hosts: all + connection: local + vars: + test: true + tasks: + - name: "Include {{ cookiecutter.github_handle.lower().replace(' ', '_').replace('-', '_') }}.{{ cookiecutter.project_slug }}" + ansible.builtin.include_role: + name: "{{ cookiecutter.github_handle.lower().replace(' ', '_').replace('-', '_') }}.{{ cookiecutter.project_slug }}" diff --git a/{{cookiecutter.project_slug}}/molecule/hostmachine1/molecule.yml b/{{cookiecutter.project_slug}}/molecule/hostmachine1/molecule.yml new file mode 100644 index 00000000..5d013aad --- /dev/null +++ b/{{cookiecutter.project_slug}}/molecule/hostmachine1/molecule.yml @@ -0,0 +1,17 @@ +--- +dependency: + name: galaxy +driver: + name: delegated + options: + managed: False + ansible_connection_options: + ansible_connection: local + ansible_sudo_pass: "${ANSIBLE_SUDO_PASSWORD}" + become_method: sudo +platforms: + - name: instance +provisioner: + name: ansible +verifier: + name: ansible diff --git a/{{cookiecutter.project_slug}}/molecule/hostmachine1/verify.yml b/{{cookiecutter.project_slug}}/molecule/hostmachine1/verify.yml new file mode 100644 index 00000000..67dbf238 --- /dev/null +++ b/{{cookiecutter.project_slug}}/molecule/hostmachine1/verify.yml @@ -0,0 +1,8 @@ +--- +- name: Verify + hosts: all + gather_facts: false + tasks: + - name: PlaceHolder Task + debug: + msg: "Verification Script." diff --git a/{{cookiecutter.project_slug}}/pyproject.toml b/{{cookiecutter.project_slug}}/pyproject.toml new file mode 100644 index 00000000..ccf69f58 --- /dev/null +++ b/{{cookiecutter.project_slug}}/pyproject.toml @@ -0,0 +1,20 @@ +[tool.poetry] +name = "{{cookiecutter.project_slug}}" +version = "0.1.0" +description = "{{cookiecutter.description}}" +authors = ["{{cookiecutter.author}} <{{cookiecutter.email}}>"] + +[tool.poetry.dependencies] +python = ">=3.6.1,<4.0" +ansible = "^3.3.0" + +[tool.poetry.dev-dependencies] +ansible-lint = "^5.0.8" +commitizen = "^2.17.6" +molecule = {extras = ["docker"], version = "^3.3.0"} +yamllint = "^1.26.1" + + +[build-system] +requires = ["poetry-core>=1.0.0"] +build-backend = "poetry.core.masonry.api" diff --git a/{{cookiecutter.project_slug}}/requirements.yml b/{{cookiecutter.project_slug}}/requirements.yml new file mode 100644 index 00000000..24698c3b --- /dev/null +++ b/{{cookiecutter.project_slug}}/requirements.yml @@ -0,0 +1,2 @@ +--- +- src: osx_provisioner.homebrew_retry diff --git a/{{cookiecutter.project_slug}}/tasks/main.yml b/{{cookiecutter.project_slug}}/tasks/main.yml new file mode 100644 index 00000000..d5ee50c6 --- /dev/null +++ b/{{cookiecutter.project_slug}}/tasks/main.yml @@ -0,0 +1,5 @@ +--- +# tasks file for {{ cookiecutter.project_slug }} + +- name: Placeholder Task + debug: msg="Your dedication and hard work goes here." diff --git a/{{cookiecutter.project_slug}}/tests/inventory b/{{cookiecutter.project_slug}}/tests/inventory new file mode 100644 index 00000000..878877b0 --- /dev/null +++ b/{{cookiecutter.project_slug}}/tests/inventory @@ -0,0 +1,2 @@ +localhost + diff --git a/{{cookiecutter.project_slug}}/tests/test.yml b/{{cookiecutter.project_slug}}/tests/test.yml new file mode 100644 index 00000000..1ed1af27 --- /dev/null +++ b/{{cookiecutter.project_slug}}/tests/test.yml @@ -0,0 +1,5 @@ +--- +- hosts: localhost + remote_user: root + roles: + - {{ cookiecutter.project_slug }} diff --git a/{{cookiecutter.project_slug}}/vars/main.yml b/{{cookiecutter.project_slug}}/vars/main.yml new file mode 100644 index 00000000..10157a92 --- /dev/null +++ b/{{cookiecutter.project_slug}}/vars/main.yml @@ -0,0 +1,2 @@ +--- +# vars file for {{ cookiecutter.project_slug }}