puppetlabs/vmpooler-dns-gcp
2
0
Fork 0
mirror of https://github.com/puppetlabs/vmpooler-dns-gcp.git synced 2026-01-26 02:58:42 -05:00
Code Issues Projects Releases Packages Wiki Activity Actions

Copy release instructions to the readme

Browse source
This commit is contained in:
Jake Spain 2023-01-30 16:45:18 -05:00
parent 22873d4c1a
commit ecff3e10aa
No known key found for this signature in database
GPG key ID: BC1C4DA0A085E113
1 changed files with 20 additions and 24 deletions
Download patch file Download diff file Expand all files Collapse all files

44
README.md
View file

@ -1,35 +1,31 @@
# Vmpooler::Dns::Google::Clouddns
# vmpooler-dns-google-clouddns
TODO: Delete this and the text below, and describe your gem
Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/vmpooler/dns/google/clouddns`. To experiment with that code, run `bin/console` for an interactive prompt.
## Installation
TODO: Replace `UPDATE_WITH_YOUR_GEM_NAME_PRIOR_TO_RELEASE_TO_RUBYGEMS_ORG` with your gem name right after releasing it to RubyGems.org. Please do not do it earlier due to security reasons. Alternatively, replace this section with instructions to install your gem from git if you don't plan to release to RubyGems.org.
Install the gem and add to the application's Gemfile by executing:
$ bundle add UPDATE_WITH_YOUR_GEM_NAME_PRIOR_TO_RELEASE_TO_RUBYGEMS_ORG
If bundler is not being used to manage dependencies, install the gem by executing:
$ gem install UPDATE_WITH_YOUR_GEM_NAME_PRIOR_TO_RELEASE_TO_RUBYGEMS_ORG
- [vmpooler-dns-google-clouddns](#vmpooler-dns-google-clouddns)
- [Usage](#usage)
- [Update the Gemfile Lock](#update-the-gemfile-lock)
- [Releasing](#releasing)
- [License](#license)
## Usage
TODO: Write usage instructions here
Examples of deploying VMPooler with extra providers can be found in the [puppetlabs/vmpooler-deployment](https://github.com/puppetlabs/vmpooler-deployment) repository.
## Development
## Update the Gemfile Lock
After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
To update the `Gemfile.lock` run `./update-gemfile-lock`.
To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
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).
## Contributing
## Releasing
Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/vmpooler-dns-google-clouddns. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/[USERNAME]/vmpooler-dns-google-clouddns/blob/initial-implementation/CODE_OF_CONDUCT.md).
Follow these steps to publish a new GitHub release, and build and push the gem to <https://rubygems.org>.
## Code of Conduct
1. Bump the "VERSION" in `lib/vmpooler-dns-google-clouddns/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.
Everyone interacting in the Vmpooler::Dns::Google::Clouddns project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/vmpooler-dns-google-clouddns/blob/initial-implementation/CODE_OF_CONDUCT.md).
## License
vmpooler-dns-google-clouddns 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.