puppetlabs/vmpooler-provider-ec2
2
0
Fork 0
mirror of https://github.com/puppetlabs/vmpooler-provider-ec2.git synced 2026-01-26 02:28:40 -05:00
Code Issues Projects Releases Packages Wiki Activity Actions

Add changelog and release instructions

Browse source
This commit is contained in:
Jake Spain 2023-01-30 09:24:55 -05:00
parent b672364a53
commit 845de6b353
No known key found for this signature in database
GPG key ID: BC1C4DA0A085E113
5 changed files with 78 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

26
README.md
View file

@ -1,5 +1,15 @@
# vmpooler-provider-aws
- [vmpooler-provider-aws](#vmpooler-provider-aws)
- [Usage](#usage)
- [Provisioning the new nodes](#provisioning-the-new-nodes)
- [DNS](#dns)
- [Labels](#labels)
- [Pre-requisite](#pre-requisite)
- [Update the Gemfile Lock](#update-the-gemfile-lock)
- [Releasing](#releasing)
- [License](#license)
This is a provider for [VMPooler](https://github.com/puppetlabs/vmpooler) allows using aws to create instances, disks,
snapshots, or destroy instances for specific pools.
@ -55,6 +65,22 @@ do not have the pool label, and can be configured to allow a specific list of un
- An IAM user must exist in the target AWS account with permissions to create, delete vms etc
- if using DNS see section above, and a service account with permissions to change Cloud DNS need to exist
## Update the Gemfile Lock
To update the `Gemfile.lock` run `./update-gemfile-lock`.
Verify, and update if needed, that the docker tag in the script and GitHub action workflows matches what is used in the [vmpooler-deployment Dockerfile](https://github.com/puppetlabs/vmpooler-deployment/blob/main/docker/Dockerfile).
## Releasing
Follow these steps to publish a new GitHub release, and build and push the gem to <https://rubygems.org>.
1. Bump the "VERSION" in `lib/vmpooler-provider-ec2/version.rb` appropriately based on changes in `CHANGELOG.md` since the last release.
2. Run `./update-gemfile-lock` to update `Gemfile.lock`.
3. Run `./update-changelog` to update `CHANGELOG.md`.
4. Commit and push changes to a new branch, then open a pull request against `main` and be sure to add the "maintenance" label.
5. After the pull request is approved and merged, then navigate to Actions --> Release Gem --> run workflow --> Branch: main --> Run workflow.
## License
vmpooler-provider-aws is distributed under the [Apache License, Version 2.0](http://www.apache.org/licenses/LICENSE-2.0.html). See the [LICENSE](LICENSE) file for more details.