Clarify module release documentation #288
Conversation
| > If necessary, run `bundle install` before continuing. | ||
| > ```bash | ||
| > bundle install --path .vendor/ --without system_tests development | ||
| > ``` | ||
| > | ||
| > And in case you installed the gems before: | ||
| > ```bash | ||
| > bundle install --path .vendor/ --without system_tests development; bundle update; bundle clean | ||
| > ``` |
There was a problem hiding this comment.
I wonder if this should be simplified to just always doing the install/update/clean command, so that you don't have to know the answer to when it would be necessary to run bundle install before continuing.
There was a problem hiding this comment.
that's the reason why I initially provided it as a long line. just copy paste it and it will set everything up.
| Before preparing a release, it may help to run modulesync to ensure the | ||
| dotfiles are up-to-date. If modulesync has been run recently by someone else, | ||
| you may not have to do it. See https://github.com/voxpupuli/modulesync for more | ||
| info on using modulesync. |
There was a problem hiding this comment.
do you think this is fine or should we enhance it with a sentence so people can check if it's actually up2date? each of our modules has the .msync.yml file with the version:
$ cat .msync.yml
---
# Managed by modulesync - DO NOT EDIT
# https://voxpupuli.org/docs/updating-files-managed-with-modulesync/
modulesync_config_version: '5.5.0'
Which maps to the tag at: https://github.com/voxpupuli/modulesync_config/tags
also maybe it's better to link to https://github.com/voxpupuli/modulesync_config/ and not https://github.com/voxpupuli/modulesync ?
This updates the module release documentation so it flows as a series of steps.
Hopefully this makes it easier to follow along for people not familiar with the process.