Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update README.md with badges; publish gem to GHA/rubygems; add missing license #17

Merged
merged 2 commits into from
Jul 30, 2021

Conversation

bastelfreak
Copy link
Member

No description provided.

@bastelfreak bastelfreak requested a review from ekohl July 26, 2021 17:43
@bastelfreak bastelfreak self-assigned this Jul 26, 2021
@@ -1,3 +1,7 @@
source 'https://rubygems.org'

gemspec

group :release do
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thoughts on not installing this by default?

Suggested change
group :release do
group :release, optional: true do

It does mean we need to update your release workflow to set BUNDLE_WITH but it makes the initial install faster.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Doesn't optional: false make more sense here? We only need it locally for generating the changelog, but not in general so it could default to false?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

https://bundler.io/man/gemfile.5.html#BLOCK-FORM-OF-SOURCE-GIT-PATH-GROUP-and-PLATFORMS

In the case of the group block form the :optional option can be given to prevent a group from being installed unless listed in the --with option given to the bundle install command.

So I think optional: true can be read as default: false.


To make a new release, please do:
* Update the version in the puppet_metadata.gemspec file
* Install gems with `bundle install --with release --path .vendor`
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

bundle install --with is deprecated. I think now it's bundle config with release && ..

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ah you're right. We really need to template the README.md somehow to get this consistent :(

@bastelfreak bastelfreak merged commit f342dd1 into voxpupuli:master Jul 30, 2021
@bastelfreak bastelfreak deleted the gha branch July 30, 2021 07:36
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants