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

Run `doc` in CI, to catch scaladoc issues #3127

Closed
dwijnand opened this Issue Apr 20, 2017 · 2 comments

Comments

Projects
None yet
2 participants
@dwijnand
Member

dwijnand commented Apr 20, 2017

h/t to @fommil for the idea.

This depends on #2812 ("Errors running sbtRoot/compile:doc") to be fixed first.

Mentoring Instructions

Links

sbt's Travis CI is split into a matrix of CI, which is found at:

sbt/.travis.yml

Lines 31 to 45 in 1d7b35b

- SBT_CMD=";mimaReportBinaryIssues ;scalafmt::test ;test:scalafmt::test ;sbt:scalafmt::test ;headerCheck ;test:headerCheck ;whitesourceCheckPolicies ;test:compile ;mainSettingsProj/test ;safeUnitTests ;otherUnitTests"
- SBT_CMD="scripted actions/*"
- SBT_CMD="scripted apiinfo/* compiler-project/* ivy-deps-management/*"
- SBT_CMD="scripted dependency-management/*1of4"
- SBT_CMD="scripted dependency-management/*2of4"
- SBT_CMD="scripted dependency-management/*3of4"
- SBT_CMD="scripted dependency-management/*4of4"
- SBT_CMD="scripted package/* reporter/* run/* project-load/*"
- SBT_CMD="scripted project/*1of2"
- SBT_CMD="scripted project/*2of2"
- SBT_CMD="scripted source-dependencies/*1of3"
- SBT_CMD="scripted source-dependencies/*2of3"
- SBT_CMD="scripted source-dependencies/*3of3"
- SBT_CMD="scripted tests/*"
- SBT_CMD="repoOverrideTest:scripted dependency-management/*"

Solution

The solution is to either add a new matrix entry of doc or add doc to one of the existing ones, depending on the relative impacts.

Testing

The best way to test this is to enable Travis CI on your own fork, and experiment with it building your branch.

Motivation

The motivation is to catch any scaladoc issues well before a release is cut.

Background

Historically we've had bad Scaladoc, which we've had to last-minute workaround during a release.

@jvican

This comment has been minimized.

Show comment
Hide comment
@jvican

jvican Apr 26, 2017

Member

This could be a Scala Center spree ticket. Are you gonna be in Scaladays Chicago @dwijnand ?

Member

jvican commented Apr 26, 2017

This could be a Scala Center spree ticket. Are you gonna be in Scaladays Chicago @dwijnand ?

@dwijnand

This comment has been minimized.

Show comment
Hide comment
@dwijnand

dwijnand Apr 27, 2017

Member

Copenhagen*, and yes I will. Labelled.

Member

dwijnand commented Apr 27, 2017

Copenhagen*, and yes I will. Labelled.

@dwijnand dwijnand added the Spree label Apr 27, 2017

@dwijnand dwijnand added this to the 1.1.1 milestone Dec 13, 2017

@dwijnand dwijnand self-assigned this Dec 13, 2017

@dwijnand dwijnand modified the milestones: 1.1.1, 1.2.0 Jan 9, 2018

@regadas regadas referenced this issue Jun 19, 2018

Merged

Add doc task to travis-ci #4218

1 of 1 task complete

@eed3si9n eed3si9n closed this in #4218 Jun 26, 2018

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment