search

ansible-community / ansible-vault

:key: Ansible role for Hashicorp Vault
BSD 2-Clause "Simplified" License
364 stars 194 forks source link

introduce semanticreleaser, commitlint, ansdoc #328

Closed FalcoSuessgott closed 1 year ago

FalcoSuessgott commented 1 year ago

Hi @bbaassssiiee,

I wanted to get your feedback about this PR. That includes some changes regarding the repository management and code quality:

  1. commitlint, semantic releaser config & action
  2. ansdoc (a tool that I wrote for this repo that should generate us a markdown table from all variables this role defines during Github Action)
  3. stale github action for closing PRs/Issues that have been inactive for longer
  4. removed some outdated files (if that is okay?)

Since these changes have a rather big outcome I wanted to double check with you.

If this PR gets merged, we would need to stick to conventional commits (but the commitlint action would verify the PR commit message anyways), but doing so we would have an automatically generated CHANGELOG.md as well as an automatic tagging, which helps consuming this role in a more secure fashion.

In order to get Semantic Releaser to work we would need a special SEMANTIC_RELEASER_TOKEN, Im not sure who has the permissions to create such Secret for that repo, maybe you can help :)

Let me know what you think :)

FalcoSuessgott commented 1 year ago

that would be the generated README by ansdoc: https://github.com/FalcoSuessgott/ansible-vault/blob/cleanup/README.md.

It is not really satisfying yet for me, I will probably try to improve the readability a bit before merging

FalcoSuessgott commented 1 year ago

Yeah your right it is probably too big. We could easily introduce stale, semrel & commitlint in separate PRs. We rework accordingly