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

Added configuration for coveralls.io #143

Merged
merged 1 commit into from
Dec 29, 2014

Conversation

abelsromero
Copy link
Member

This PR is meant to close the issue #107 adding coverage data with coveralls.io.
For @mojavelinux advise I added a coment on the .travis.yml file and created a wiki page descriving the process.
https://github.com/abelsromero/asciidoctor-maven-plugin/wiki/Coveralls.io-configuration
If everythingt is fine with the document I'll migrate it to the main ascidoctor's wiki.

PS: once is merged I'll edit the badge on the readme.

@coveralls
Copy link

Coverage Status

Changes Unknown when pulling 721a403 on abelsromero:master into * on asciidoctor:master*.

@@ -4,3 +4,6 @@ jdk:
- oraclejdk7
- openjdk7
- openjdk6
after_success:
# 'coveralls:report' goal is responsible for updating coverall.io stats once travisCI build completes
- mvn clean test jacoco:report coveralls:report
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I like the comment.

I have two small change requests.

(1) Can you indent the commented line so that we avoid any YAML parse errors? (Different parsers seem to have different rules, but in general the indentation should match the line it's commenting).

(2) Why are we using after_success? It seems like this will end up running the tests twice. Or is that the intention? I'm thinking more along the lines of:

script:
  - mvn clean test jacoco:report
after_success:
  # the coveralls:report goal is responsible for updating the coveralls.io stats once the build completes
  - mvn coveralls:report

Or is the clean test required when using coveralls? If so, could we just run it all inside a single command in the script:

script:
  # the coveralls:report goal is responsible for updating the coveralls.io stats once the build completes
  - mvn clean test jacoco:report coveralls:report

Or perhaps the after_success is only run once and not for every time through the matrix. In which case, I see why it is done this way.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Where is the auth token for coveralls.io stored? Is that an integration Travis provides by default?

@coveralls
Copy link

Coverage Status

Changes Unknown when pulling c6b115b on abelsromero:master into * on asciidoctor:master*.

@coveralls
Copy link

Coverage Status

Changes Unknown when pulling c033895 on abelsromero:master into * on asciidoctor:master*.

@coveralls
Copy link

Coverage Status

Changes Unknown when pulling c033895 on abelsromero:master into * on asciidoctor:master*.

1 similar comment
@coveralls
Copy link

Coverage Status

Changes Unknown when pulling c033895 on abelsromero:master into * on asciidoctor:master*.

@abelsromero
Copy link
Member Author

You were right @mojavelinux, test were executed more than once.
The new travis config splits the whole build into three steps (install, script and after_success) to avoid repetitions, now everything runs once:
. install: just compiles everything (test included)
. script: executed the tests and generates reports necessaries
. after_success: updated coveralls data

Where is the auth token for coveralls.io stored? Is that an integration Travis provides by default?

I moved the article from my wiki to https://github.com/asciidoctor/asciidoctor/wiki, I created a new section called Projects manteinance. Let me know it answers your doubt or you see anything wrong.

@mojavelinux
Copy link
Member

I moved the article from my wiki to https://github.com/asciidoctor/asciidoctor/wiki, I created a new section called Projects manteinance. Let me know it answers your doubt or you see anything wrong.

That is some seriously good information. Thank you for writing that up! Now we're going to remember how it was setup for sure.

Eventually, this page might just become universal information for coveralls.io in the Asciidoctor ecosystem since much of it applies to any repository. We'll update it as needed. What's important is that it exists.

@@ -4,3 +4,11 @@ jdk:
- oraclejdk7
- openjdk7
- openjdk6
install:
- mvn test-compile -DskipTests=true -Dmaven.javadoc.skip=true -B -V
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Let's use package instead of test-compile for this goal. That ensures we go through the whole cycle at least once (we hit tests in the subsequent steps).

@mojavelinux
Copy link
Member

I have one minor change request. Then, it looks good to merge!

@coveralls
Copy link

Coverage Status

Changes Unknown when pulling 4ea1615 on abelsromero:master into * on asciidoctor:master*.

@abelsromero
Copy link
Member Author

I updated (and squashed) the file with the package change.
AppVeyor finised OK (https://ci.appveyor.com/project/asciidoctor/asciidoctor-maven-plugin/build/12) but the PR is not updating 😞
If does no update in a couple of hours I'll merge it, ok?

@mojavelinux
Copy link
Member

I'll take a quick peek, then give a thumbs up if all looks good.

mojavelinux added a commit that referenced this pull request Dec 29, 2014
Added configuration for coveralls.io
@mojavelinux mojavelinux merged commit ad67958 into asciidoctor:master Dec 29, 2014
@mojavelinux
Copy link
Member

Looks good! I've merged.

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.

3 participants