# Docs For Maintainers This describes the actions required for maintainers of the repo, as well as any other things that might be useful to know. See `docs/development.md` for more information on generating the modules for this repository. ## Releases Release versions follow the semver versioning pattern. To create a new release: 1. Install `antsibull-docs` via pip 2. Create a new branch on your fork, usually called `release/` 3. Increment the collection version in the `galaxy.yml` 4. Run `antsibull-changelog release`. This will delete the changelog fragments and write the new changelog to `CHANGELOG.rst`. 5. Commit the changes with the commit message `release ` 6. Open a PR to merge the release branch into main. Once the PR has been merged: 7. Use the Github UI to create a new release. You must tag main with the new version number. The tag is just the version number, not `v0.0.0` 8. Pull the new version of main. You can do a `git reset --hard HEAD` and `git clean -dfx` if you have any extra files present. You do not want any extra files present. 9. Build the collection, `ansible-galaxy collection build .`. This will create a tar file. 10. Optionally, inspect the tar file to make sure no extra files were included: `tar -tf ` 11. Upload the new tar file to Ansible Galaxy 12. Upload the new tar file to Automation Hub ### Supporting Ansible Core Versions When a version of Ansible core is no longer supported by the repo, you need to update the documentation (`README.md`), remove the version from the GH workflows (`sanity-tests.yml`), update the `MANIFEST.yml`, and update the minimum version in `meta/runtime.yml`. Deprecating a version is a major version change. When you are ready to add a new version of Ansible core, you need to add it to the GH workflows (`ansible-sanity.yml`). Supporting a new version is a minor version change. ## Testing Testing is done as a part of the pull request workflow. There are a few key tests: - integration tests, run against an actual vCenter (Eco-vCenter) - sanity tests (includes a variety of linters) ### Run tests locally These commands will attempt to install python packages. You can create and activate a virtual env beforehand to avoid installing packages to the system python. To run sanity tests: ```bash make sanity ``` To run integration tests against a vCenter lab: ```bash # set env variables for auth export VCENTER_HOSTNAME='my-vcenter.example.com' export VCENTER_USERNAME='someuser@vcenter.local' export VCENTER_PASSWORD='password' make eco-vcenter-ci ```