Debian Codegraph @

ansible_collections/vmware/vmware_rest/docs/maintainer.md

raw
1 # Docs For Maintainers
2
3 This describes the actions required for maintainers of the repo, as well as any other things that might be useful to know.
4 See `docs/development.md` for more information on generating the modules for this repository.
5
6 ## Releases
7
8 Release versions follow the semver versioning pattern. To create a new release:
9
10 1. Install `antsibull-docs` via pip
11 2. Create a new branch on your fork, usually called `release/<new version>`
12 3. Increment the collection version in the `galaxy.yml`
13 4. Run `antsibull-changelog release`. This will delete the changelog fragments and write the new changelog to `CHANGELOG.rst`.
14 5. Commit the changes with the commit message `release <new version>`
15 6. Open a PR to merge the release branch into main.
16
17 Once the PR has been merged:
18
19 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`
20 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.
21 9. Build the collection, `ansible-galaxy collection build .`. This will create a tar file.
22 10. Optionally, inspect the tar file to make sure no extra files were included: `tar -tf <tar file name>`
23 11. Upload the new tar file to Ansible Galaxy
24 12. Upload the new tar file to Automation Hub
25
26 ### Supporting Ansible Core Versions
27
28 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.
29
30 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.
31
32 ## Testing
33
34 Testing is done as a part of the pull request workflow. There are a few key tests:
35 - integration tests, run against an actual vCenter (Eco-vCenter)
36 - sanity tests (includes a variety of linters)
37
38 ### Run tests locally
39
40 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.
41
42 To run sanity tests:
43 ```bash
44 make sanity
45 ```
46
47 To run integration tests against a vCenter lab:
48 ```bash
49 # set env variables for auth
50 export VCENTER_HOSTNAME='my-vcenter.example.com'
51 export VCENTER_USERNAME='[email protected]'
52 export VCENTER_PASSWORD='password'
53 make eco-vcenter-ci
54 ```