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

Fix CONTRIBUTING documentation #697

Closed
wants to merge 2 commits into from

Conversation

stevenpost
Copy link
Contributor

This PR updates the CONTRIBUTING.md file so given commands are actually valid and tests can be run.
The bundler commands given contained deprecated arguments that no longer worked.

Several arguments no longer work. Despite looking like a warning,
bundler will still try to use the system path.

```
$ bundle install --path .vendor/ --without development system_tests release --jobs "$(nproc)"
[DEPRECATED] The `--path` flag is deprecated because it relies on being remembered across bundler invocations, which bundler will no longer do in future versions. Instead please use `bundle config set --local path '.vendor/'`, and stop using this flag
[DEPRECATED] The `--without` flag is deprecated because it relies on being remembered across bundler invocations, which bundler will no longer do in future versions. Instead please use `bundle config set --local without 'development system_tests release'`, and stop using this flag
Bundler 2.4.10 is running, but your lockfile was generated with 2.3.26. Installing Bundler 2.3.26 and restarting using that version.
```
Running the rspec tests require first running the `spec_prep` rake
command. This wasn't documented. An argument can be made for it being
'common knowledge', but that goes out the window with the 'all in one
solution' for using bundler.
@bastelfreak
Copy link
Member

@stevenpost thanks for the PR! The file is actually rendered from a template: https://github.com/voxpupuli/modulesync_config/blob/master/moduleroot/.github/CONTRIBUTING.md.erb

could you please send the PR to the template?

@stevenpost
Copy link
Contributor Author

@stevenpost thanks for the PR! The file is actually rendered from a template: https://github.com/voxpupuli/modulesync_config/blob/master/moduleroot/.github/CONTRIBUTING.md.erb

could you please send the PR to the template?

I'll have a look, will reference it here and then close this PR.

@stevenpost
Copy link
Contributor Author

Superseeded by voxpupuli/modulesync_config#881
Transposing the changes was easy enough:

git format-patch master..
sed -i 's;\.github/CONTRIBUTING.md;moduleroot/.github/CONTRIBUTING.md.erb;g' 000*
cd ../modulesync_config
git am ../puppet-mongodb/000*

@stevenpost stevenpost closed this Mar 13, 2024
@stevenpost stevenpost deleted the bundler_update branch March 13, 2024 16:04
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