Skip to content

Commit

Permalink
feat: Implement role and galaxy metadata template
Browse files Browse the repository at this point in the history
Signed-off-by: 林博仁(Buo-ren Lin) <[email protected]>
  • Loading branch information
brlin-tw committed Sep 25, 2024
1 parent a0dc075 commit 5be52c4
Show file tree
Hide file tree
Showing 3 changed files with 41 additions and 0 deletions.
1 change: 1 addition & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -61,6 +61,7 @@ A sensible Ansible role template for initializing a new project.
1. Replace [.markdownlint.yml](.markdownlint.yml) with [real.markdownlint.yml](real.markdownlint.yml)
1. Replace [README.md](README.md)(this document) with [real.README.md](real.README.md)
1. Customize/remove Telegram notification details in [.github/workflows/check-potential-problems.yml](.github/workflows/check-potential-problems.yml)
1. Rename [the meta/real.main.yml main metadata configuration file template](meta/real.meta.yml) to meta/main.yml and customize it according to your project.
1. Commit all changes as a new revision(commit summary for reference: `docs: Write project README prototype`)
1. (If you've cloned the repository back to local) push local changes to the remote repository
Expand Down
3 changes: 3 additions & 0 deletions meta/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# meta

Provides metadata for the Ansible role itself and [Ansible Galaxy](https://galaxy.ansible.com/).
37 changes: 37 additions & 0 deletions meta/real.main.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
# Ansible role metadata
#
# Reference:
#
# * Role directory structure — Roles — Ansible Documentation
# https://docs.ansible.com/ansible/latest/user_guide/playbooks_reuse_roles.html#role-directory-structure
# * Using `meta/main.yml — Dependencies — Galaxy User Guide — Ansible
# Galaxy Documentation
# https://docs.ansible.com/ansible/latest/galaxy/user_guide.html#using-meta-main-yml
# * Role Metadata — Creating Roles — Ansible Galaxy Documentation
# https://old-galaxy.ansible.com/docs/contributing/creating_role.html#role-metadata
#
# Copyright 2024 林博仁(Buo-ren Lin) <[email protected]>
# SPDX-License-Identifier: CC-BY-SA-4.0+ OR LicenseRef-Apache-2.0-If-Not-Used-In-Template-Projects

galaxy_info:
role_name: _name_
author: _namespace_
description: _description_
license: _license_

# Refer to the following documentation for the currently officially supported ansible-core releases:
# ansible-core release cycle — Releases and maintenance — Ansible Community Documentation
# https://docs.ansible.com/ansible/devel/reference_appendices/release_and_maintenance.html#ansible-core-release-cycle
min_ansible_version: '2.15'

# List tags for your role here, one per line. A tag is a keyword that describes
# and categorizes the role. Users find roles by searching for tags. Be sure to
# remove the '[]' above, if you add tags to this list.
#
# NOTE: A tag is limited to a single word comprised of alphanumeric characters.
# Maximum 20 tags per role.
galaxy_tags: []

# List your role dependencies here, one per line. Be sure to remove the '[]' above,
# if you add dependencies to this list.
dependencies: []

0 comments on commit 5be52c4

Please sign in to comment.