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

Add CI job to add docs to Github pages #160

Merged
merged 2 commits into from
Jul 27, 2020

Conversation

echeran
Copy link
Contributor

@echeran echeran commented Jun 26, 2020

Closes #111

@echeran echeran requested review from zbraniecki and sffc June 26, 2020 20:52
@echeran echeran requested a review from a team as a code owner June 26, 2020 20:52
@coveralls
Copy link

coveralls commented Jun 26, 2020

Pull Request Test Coverage Report for Build 14ee6e9f6f85d3667ed9023db482105ba3754950-PR-160

  • 0 of 0 changed or added relevant lines in 0 files are covered.
  • 4 unchanged lines in 2 files lost coverage.
  • Overall coverage decreased (-0.3%) to 90.758%

Files with Coverage Reduction New Missed Lines %
components/locale/src/extensions/transform/key.rs 2 90.0%
components/locale/src/extensions/unicode/key.rs 2 90.91%
Totals Coverage Status
Change from base Build 1e3b00ea3b0456993de8f1f2ee0b4cbfb90ddc7f: -0.3%
Covered Lines: 1149
Relevant Lines: 1266

💛 - Coveralls

@sffc
Copy link
Member

sffc commented Jun 27, 2020

Cool!

Are the docs posted yet for preview?

Why does it say "this check was skipped"?

@echeran
Copy link
Contributor Author

echeran commented Jun 27, 2020

I forgot to mention that. The URL is: https://unicode-org.github.io/icu4x-docs/

It says the check was skipped b/c it only runs on master, not PRs,. I mentioned over in the issue that PRs (which are WIP) shouldn't be allowed to clobber the latest version of our docs based on our code from master, which has passed review.

zbraniecki
zbraniecki previously approved these changes Jun 27, 2020
@sffc
Copy link
Member

sffc commented Jul 15, 2020

Why does https://unicode-org.github.io/icu4x-docs/icu4x/ show all of our dependencies as crates? Is there a way to fix that?

@filmil
Copy link
Contributor

filmil commented Jul 15, 2020

Why does https://unicode-org.github.io/icu4x-docs/icu4x/ show all of our dependencies as crates? Is there a way to fix that?

Looks like cargo is able to omit dependencies if specifically asked to do so:
https://stackoverflow.com/questions/34215411/how-do-i-prevent-rust-doc-from-adding-dependencies-to-documentation

@echeran
Copy link
Contributor Author

echeran commented Jul 16, 2020

Yep, thanks for the link. The new commit adds the --no-deps arg. A test on my personal fork shows the cleaned up docs in the docs repo at https://echeran.github.io/icu4x-docs/.

sffc
sffc previously approved these changes Jul 16, 2020
Copy link
Member

@sffc sffc left a comment

Choose a reason for hiding this comment

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

Optional: I don't know when you decide to lump things into "build-test.yml" and when you split things into new files like you did with "coverage.yml". Personally, I think docs deserve their own file.

@echeran echeran requested a review from zbraniecki July 16, 2020 16:25
@echeran
Copy link
Contributor Author

echeran commented Jul 16, 2020

I initially considered a separate workflow, but then I confirmed the fact that workflows cannot depend on each other. Only jobs within a workflow can depend on each other. And I don't want the docs to be generated if the code doesn't build / tests don't pass.

And since formatting is quicker thing to check than doc generation but is required for all commits, I also made that a dependency of docs too so that we don't generate docs needlessly when formatting needs cleanup. (I guess docs are generated from parts of code that adhere to a certain format, so that docs generation job dep on formatting should make sense for that reason, too.)

zbraniecki
zbraniecki previously approved these changes Jul 23, 2020
@echeran echeran dismissed stale reviews from zbraniecki and sffc via df92f06 July 27, 2020 16:57
@echeran echeran merged commit d2ba9b3 into unicode-org:master Jul 27, 2020
@echeran echeran deleted the ci-gh-pages branch October 6, 2020 18:01
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.

Add docs to GitHub pages
5 participants