Refactor code for maintainabilty #206
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
neomilium
force-pushed
the
code-refactoring
branch
3 times, most recently
from
cb9243b
to
51d5c96
Compare
neomilium
force-pushed
the
code-refactoring
branch
from
51d5c96
to
758f86a
Compare
|
This PR is so big... I started to split it to speed up review and merges. |
neomilium
added a commit
to opus-codium/modulesync
that referenced
this pull request
Apr 21, 2021
Please note that previous commit introduced some offences that will be fixed in upcomming commits (some are already available in voxpupuli#206
neomilium
added a commit
to opus-codium/modulesync
that referenced
this pull request
Apr 21, 2021
Please note that previous commit introduced some offences that will be fixed in upcomming commits (some are already available in voxpupuli#206
neomilium
added a commit
to opus-codium/modulesync
that referenced
this pull request
Apr 21, 2021
Please note that previous commit introduced some offences that will be fixed in upcomming commits (some are already available in voxpupuli#206
neomilium
added a commit
to opus-codium/modulesync
that referenced
this pull request
Apr 21, 2021
Please note that previous commit introduced some offences that will be fixed in upcomming commits (some are already available in voxpupuli#206
neomilium
force-pushed
the
code-refactoring
branch
from
758f86a
to
020c608
Compare
neomilium
force-pushed
the
code-refactoring
branch
2 times, most recently
from
2a43a87
to
36fb210
Compare
neomilium
force-pushed
the
code-refactoring
branch
from
36fb210
to
5f023d3
Compare
neomilium
force-pushed
the
code-refactoring
branch
8 times, most recently
from
8ae088c
to
7fd4261
Compare
|
This PR is stalled, waiting #219 to be merged. |
neomilium
force-pushed
the
code-refactoring
branch
from
7fd4261
to
c9561eb
Compare
neomilium
force-pushed
the
code-refactoring
branch
from
c9561eb
to
2492cf4
Compare
Codecov Report
@@ Coverage Diff @@
## master #206 +/- ##
==========================================
+ Coverage 84.76% 85.93% +1.16%
==========================================
Files 30 30
Lines 906 917 +11
==========================================
+ Hits 768 788 +20
+ Misses 138 129 -9
Continue to review full report at Codecov.
|
neomilium
force-pushed
the
code-refactoring
branch
4 times, most recently
from
cac2762
to
8c8d4ad
Compare
This commit reduces the default output verbosity but allow user to increase it through `--verbose` option.
neomilium
force-pushed
the
code-refactoring
branch
from
8c8d4ad
to
c31c64c
Compare
During debug, the following git error raised: fatal: ambiguous argument 'XXX': unknown revision or path not in the working tree. Use '--' to separate paths from revisions, like this: 'git <command> [<revision>...] -- [<file>...]' With the git help recommandation the error is (a bit) more explicit: fatal: bad revision 'XXX'
neomilium
force-pushed
the
code-refactoring
branch
from
c31c64c
to
5a03a6d
Compare
|
To end the story, this PR have been split in several PRs:
Its now time to append some various improvements I noted during refactoring. |
Merged
bastelfreak
reviewed
Oct 18, 2021
| @@ -12,14 +12,13 @@ def self.defaults | |||
| end | |||
|
|
|||
| class Hook < Thor | |||
| class_option :project_root, | |||
There was a problem hiding this comment.
can you explain why you drop the parameter? that means we need to do a major release?
There was a problem hiding this comment.
can you explain why you drop the parameter?
Yes, its not used in hook.
that means we need to do a major release?
No, I do not think so. I was just a extra parameter with no effect, AFAICS.
bastelfreak
approved these changes
Oct 19, 2021
ekohl
reviewed
Oct 19, 2021
Comment on lines
+23
to
+24
| endpoint += '/api/v4' | ||
| endpoint |
There was a problem hiding this comment.
Another way of writing this (but I'm not sure this is clearer)
Suggested change
| endpoint += '/api/v4' | |
| endpoint | |
| endpoint + '/api/v4' |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR improves code structure to help owners to maintain the code and contributors to add features.
About the maintainability, this PR attempts to:
optionswere passed to many methods)rubocophappier ;-)This PR also adds tests for bump, tag and changelog features.
To help contributors, this PR renames some methods with IMHO more explicit names and organizes code into classes.
Even
msynchave been made to manage Puppet modules, there are some users which use it for other purpose (e.g. @raphink wrote https://dev.to/camptocamp-ops/templating-puppet-control-repositories-3pk7) so I started to split specific code intoPuppetModuleclass, while generic one is now inSourceCodeclass.More details in commit logs.