commit 6889fdc5f2e7cadbf2d7880a1b3fa1bf0a70a4e1 Author: Andrew Ying Date: Sat Nov 16 23:15:05 2024 +0000 Initialise repository diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..740c811 --- /dev/null +++ b/.gitignore @@ -0,0 +1,132 @@ +/tests/output/ +/changelogs/.plugin-cache.yaml + +# Byte-compiled / optimized / DLL files +__pycache__/ +*.py[cod] +*$py.class + +# C extensions +*.so + +# Distribution / packaging +.Python +build/ +develop-eggs/ +dist/ +downloads/ +eggs/ +.eggs/ +lib/ +lib64/ +parts/ +sdist/ +var/ +wheels/ +pip-wheel-metadata/ +share/python-wheels/ +*.egg-info/ +.installed.cfg +*.egg +MANIFEST + +# PyInstaller +# Usually these files are written by a python script from a template +# before PyInstaller builds the exe, so as to inject date/other infos into it. +*.manifest +*.spec + +# Installer logs +pip-log.txt +pip-delete-this-directory.txt + +# Unit test / coverage reports +htmlcov/ +.tox/ +.nox/ +.coverage +.coverage.* +.cache +nosetests.xml +coverage.xml +*.cover +*.py,cover +.hypothesis/ +.pytest_cache/ + +# Translations +*.mo +*.pot + +# Django stuff: +*.log +local_settings.py +db.sqlite3 +db.sqlite3-journal + +# Flask stuff: +instance/ +.webassets-cache + +# Scrapy stuff: +.scrapy + +# Sphinx documentation +docs/_build/ + +# PyBuilder +target/ + +# Jupyter Notebook +.ipynb_checkpoints + +# IPython +profile_default/ +ipython_config.py + +# pyenv +.python-version + +# pipenv +# According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control. +# However, in case of collaboration, if having platform-specific dependencies or dependencies +# having no cross-platform support, pipenv may install dependencies that don't work, or not +# install all needed dependencies. +#Pipfile.lock + +# PEP 582; used by e.g. github.com/David-OConnor/pyflow +__pypackages__/ + +# Celery stuff +celerybeat-schedule +celerybeat.pid + +# SageMath parsed files +*.sage.py + +# Environments +.env +.venv +env/ +venv/ +ENV/ +env.bak/ +venv.bak/ + +# Spyder project settings +.spyderproject +.spyproject + +# Rope project settings +.ropeproject + +# mkdocs documentation +/site + +# mypy +.mypy_cache/ +.dmypy.json +dmypy.json + +# Pyre type checker +.pyre/ diff --git a/.yamllint.yml b/.yamllint.yml new file mode 100644 index 0000000..c265c66 --- /dev/null +++ b/.yamllint.yml @@ -0,0 +1,25 @@ +--- +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 + empty-lines: + max: 3 + level: error + hyphens: + level: error + line-length: + max: 200 + truthy: + check-keys: false diff --git a/LICENSE.md b/LICENSE.md new file mode 100644 index 0000000..92e9646 --- /dev/null +++ b/LICENSE.md @@ -0,0 +1,24 @@ +Copyright © 2024 Witine Limited and subsidiaries. + +Redistribution and use in source and binary forms, with or without modification, +are permitted provided that the following conditions are met: + +1. Redistributions of source code must retain the above copyright notice, this + list of conditions and the following disclaimer. +2. Redistributions in binary form must reproduce the above copyright notice, + this list of conditions and the following disclaimer in the documentation + and/or other materials provided with the distribution. +3. Neither the name of the copyright holder nor the names of its contributors + may be used to endorse or promote products derived from this software without + specific prior written permission. + +THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND +ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED +WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE +DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR +ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES +(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; +LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON +ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT +(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS +SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. diff --git a/README.md b/README.md new file mode 100644 index 0000000..2c4c59c --- /dev/null +++ b/README.md @@ -0,0 +1,104 @@ +# Valkey Collection for Ansible + +This is a work in progress. This package is unstable and may not work as +expected, or may not work at all. Use this package at your own risk. + +## Code of Conduct + +We follow the [Ansible Code of Conduct](https://docs.ansible.com/ansible/devel/community/code_of_conduct.html) +in all our interactions within this project. + +If you encounter abusive behavior, please refer to the [policy violations](https://docs.ansible.com/ansible/devel/community/code_of_conduct.html#policy-violations) +section of the Code for information on how to raise a complaint. + +## Contributing to this collection + +We are actively accepting new contributors and all types of contributions are +very welcome. + +Don't know how to start? Refer to the [Ansible community guide](https://docs.ansible.com/ansible/devel/community/index.html)! + +Want to submit code changes? Take a look at the [Quick-start development guide](https://docs.ansible.com/ansible/devel/community/create_pr_quick_start.html). + +We also use the following guidelines: + +* [Collection review checklist](https://docs.ansible.com/ansible/devel/community/collection_contributors/collection_reviewing.html) +* [Ansible development guide](https://docs.ansible.com/ansible/devel/dev_guide/index.html) +* [Ansible collection development guide](https://docs.ansible.com/ansible/devel/dev_guide/developing_collections.html#contributing-to-collections) + +## Tested with Ansible + + + +## External requirements + + + +## Included content + + + +## Using this collection + + + +### Installing the Collection from Ansible Galaxy + +Before using this collection, you need to install it with the Ansible Galaxy +command-line tool: +```bash +ansible-galaxy collection install witine.valkey +``` + +You can also include it in a `requirements.yml` file and install it with +`ansible-galaxy collection install -r requirements.yml`, using the format: +```yaml +--- +collections: + - name: witine.valkey +``` + +Note that if you install the collection from Ansible Galaxy, it will not be +upgraded automatically when you upgrade the `ansible` package. To upgrade the +collection to the latest available version, run the following command: +```bash +ansible-galaxy collection install witine.valkey --upgrade +``` + +You can also install a specific version of the collection, for example, if you +need to downgrade when something is broken in the latest version (please report +an issue in this repository). Use the following syntax to install version +`0.1.0`: + +```bash +ansible-galaxy collection install witine.valkey:==0.1.0 +``` + +See [using Ansible collections](https://docs.ansible.com/ansible/devel/user_guide/collections_using.html) +for more details. + +## Release notes + +See the [changelog](https://github.com/ansible-collections/REPONAMEHERE/tree/main/CHANGELOG.rst). + +## More information + +- [Ansible user guide](https://docs.ansible.com/ansible/devel/user_guide/index.html) +- [Ansible developer guide](https://docs.ansible.com/ansible/devel/dev_guide/index.html) +- [Ansible collections requirements](https://docs.ansible.com/ansible/devel/community/collection_contributors/collection_requirements.html) +- [Ansible community Code of Conduct](https://docs.ansible.com/ansible/devel/community/code_of_conduct.html) +- [The Bullhorn (the Ansible contributor newsletter)](https://docs.ansible.com/ansible/devel/community/communication.html#the-bullhorn) +- [Important announcements for maintainers](https://github.com/ansible-collections/news-for-maintainers) + +## Postcardware + +You're free to use this package, but if it makes it to your production +environment, we'd really appreciate you sending us a postcard, mentioning which +of our package(s) you are using. + +Our address is: Witine Limited, St John's Innovation Centre, Cowley Road, +Cambridge CB4 0WS, United Kingdom + +## Licensing + +This package is licensed under the [3-clause BSD License](LICENSE.md). diff --git a/changelogs/config.yaml b/changelogs/config.yaml new file mode 100644 index 0000000..64fdfa7 --- /dev/null +++ b/changelogs/config.yaml @@ -0,0 +1,38 @@ +add_plugin_period: true +changelog_filename_template: ../CHANGELOG.md +changelog_filename_version_depth: 0 +changelog_nice_yaml: false +changelog_sort: alphanumerical +changes_file: changelog.yaml +changes_format: combined +ignore_other_fragment_extensions: true +keep_fragments: false +mention_ancestor: true +new_plugins_after_name: removed_features +notesdir: fragments +output_formats: +- md +prelude_section_name: release_summary +prelude_section_title: Release Summary +sanitize_changelog: true +sections: +- - major_changes + - Major Changes +- - minor_changes + - Minor Changes +- - breaking_changes + - Breaking Changes / Porting Guide +- - deprecated_features + - Deprecated Features +- - removed_features + - Removed Features (previously deprecated) +- - security_fixes + - Security Fixes +- - bugfixes + - Bugfixes +- - known_issues + - Known Issues +title: witine.valkey Changelog +trivial_section_name: trivial +use_fqcn: true +vcs: auto diff --git a/galaxy.yml b/galaxy.yml new file mode 100644 index 0000000..58aee5b --- /dev/null +++ b/galaxy.yml @@ -0,0 +1,18 @@ +--- +namespace: witine +name: valkey +version: 0.1.0-dev +readme: README.md +authors: + - Andrew Ying (github.com/andrewying) +description: null +license_file: LICENSE.md +tags: + - valkey + - redis +repository: https://git.witine.com/witine/ansible-collection-valkey +homepage: https://git.witine.com/witine/ansible-collection-valkey +issues: https://git.witine.com/witine/ansible-collection-valkey/issues +build_ignore: + - .gitignore + - changelogs/.plugin-cache.yaml diff --git a/meta/runtime.yml b/meta/runtime.yml new file mode 100644 index 0000000..873e797 --- /dev/null +++ b/meta/runtime.yml @@ -0,0 +1,2 @@ +--- +requires_ansible: '>=2.13.0'