Release v0.3.1 #22
Release v0.3.1 #22
Conversation
CHANGELOG.md
Outdated
| Version 0.3.1 *(08/02/2017)* | ||
| -------------------------- | ||
|
|
||
| - Honour exclude filters in Findbugs tasks ([PR#20](https://github.com/novoda/gradle-static-analysis-plugin/pull/20)) |
There was a problem hiding this comment.
you can just type PR #20, like so: PR #20
There was a problem hiding this comment.
@takecare I wasn't sure it would work in this file too, I'll try
There was a problem hiding this comment.
ah i think you're right, it won't work!
There was a problem hiding this comment.
I checked, it doesn't work indeed (I might even had done the same check before 😅 )
CHANGELOG.md
Outdated
| @@ -1,6 +1,11 @@ | |||
| Change Log | |||
| ========== | |||
|
|
|||
| Version 0.3.1 *(08/02/2017)* | |||
There was a problem hiding this comment.
Will merging this trigger a build and release? If not, the release should go before updating this imo
There was a problem hiding this comment.
There is no automatic trigger at the moment, but ideally it would yes. Once this gets merged the task on the CI will execute publishRelease that in turn will scan the changelog file to fill the release and create the tag
There was a problem hiding this comment.
To be honest we could remove the date completely and add links to the GH release instead. What you think @ataulm?
There was a problem hiding this comment.
To be honest we could remove the date completely and add links to the GH release instead. What you think @ataulm?
I think safer since the date could be incorrect (if no one merges this til tomorrow, then the release doesn't actually happen til the day after).
With the link to releases, the link will be broken, but when the release is made, it will work (or link to releases page)
There was a problem hiding this comment.
Yes plus one for link to release instead of date
| apply plugin: 'org.ajoberstar.github-pages' | ||
|
|
||
| githubPages { | ||
| commitMessage = "Deploy groovydoc for release $tag" |
| } | ||
| } | ||
|
|
||
| task prepareGhCredentials { |
There was a problem hiding this comment.
i'd stick to Github (clearer and consistent)
There was a problem hiding this comment.
it was to align with the naming used by one of the gradle plugin we are using to use the git/github API
There was a problem hiding this comment.
👍 just mentioned it 'cause there's a githubPages just above
There was a problem hiding this comment.
yeah, that extension (and the incosistent naming) is coming from the aforementioned plugin 👼
| @@ -20,3 +20,6 @@ local.properties | |||
|
|
|||
| # Generated files | |||
| gen/ | |||
|
|
|||
| # Properties files | |||
| secrets.properties | |||
|
|
||
| String extractChangelog() { | ||
| String fullChangelog = rootProject.file('CHANGELOG.md').text | ||
| def latestChangelog = (fullChangelog =~ /Version ${project.version}.*\n-*([\s\S]*?)Version.*\n-*/) |
There was a problem hiding this comment.
Gotta thanks the god of regex 😄
There was a problem hiding this comment.
is there a format to follow? As in, a guide on how to adhere to the required format
There was a problem hiding this comment.
@florianmski The struggle was real! But you probably remember ;)
There was a problem hiding this comment.
@ataulm yes, this is assuming the changelog is written always following a specific structure. The script here is a first draft, something I hacked together a while ago that I feel should not be just a stashed snippet. Soon a follow-up PR will enhance this script adding the missing piece of functionality (the creation of a release entry in GitHub) and the documentation on how to release (including the format of the changelog).
Scope of the PR
We want to release a new version of the plugin on Novoda Bintray maven repo, to ship the changes from #20.
Considerations and implementation
READMEto be compliant with internal conventionCHANGELOGto track changes in releases