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

semanticRelease extension is inconsistent #2

Closed
tschulte opened this issue Sep 14, 2015 · 0 comments
Closed

semanticRelease extension is inconsistent #2

tschulte opened this issue Sep 14, 2015 · 0 comments

Comments

@tschulte
Copy link
Owner

Currently, the semanticRelease extension allows to configure the changeLog, releaseBranches and branchNames. But because of a sloppy implementation, this is inconsistent:

semanticRelease {
    changeLog {
        changeScope = { ... }
    }
    releaseBranches {
        include 'release'
    }
    branchNames {
        replace 'dev/', ''
    }
}

vs.

semanticRelease {
    changeLogService.changeScope = { ... }
    onReleaseBranch.include 'release'
    appendBranchName.replace 'dev/', ''
}

This should be fixed. One way could be to rename the properties to match the methods with the closures. Thus resulting in the second part to become

semanticRelease {
    changeLog.changeScope = { ... }
    releaseBranches.include 'release'
    branchNames.replace 'dev/', ''
}

To not trigger a major version bump, add getter methods with the old wrong names marked as @deprecated. These methods should also trigger a deprecation warning on the console.

Once a bump to 2.0.0 is necessary, remove the deprecated methods.

@tschulte tschulte added this to the 1.0 milestone Sep 14, 2015
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

1 participant