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

Deploy documentation automatically #211

Merged
merged 3 commits into from
Jun 22, 2020

Conversation

Luni-4
Copy link
Collaborator

@Luni-4 Luni-4 commented Jun 11, 2020

Once we release, the documentation is deployed automatically.

Thanks in advance for your review! :)

@Luni-4 Luni-4 requested a review from marco-c June 11, 2020 10:02
@codecov-commenter
Copy link

codecov-commenter commented Jun 11, 2020

Codecov Report

Merging #211 into master will decrease coverage by 0.78%.
The diff coverage is n/a.

Impacted file tree graph

@@            Coverage Diff             @@
##           master     #211      +/-   ##
==========================================
- Coverage   16.58%   15.79%   -0.79%     
==========================================
  Files          46       46              
  Lines        5832     5832              
  Branches      695      695              
==========================================
- Hits          967      921      -46     
- Misses       4465     4521      +56     
+ Partials      400      390      -10     
Impacted Files Coverage Δ
src/c_macro.rs 0.00% <0.00%> (-83.02%) ⬇️
src/metrics/loc.rs 45.00% <0.00%> (-1.67%) ⬇️

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 885298c...3da851e. Read the comment docs.

Copy link
Collaborator

@marco-c marco-c left a comment

Choose a reason for hiding this comment

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

We should add a task that builds the documentation (which we run all the time), and then the release task will publish it (getting the documentation artifact from the first task).

@Luni-4
Copy link
Collaborator Author

Luni-4 commented Jun 11, 2020

I agree on the documentation task (for cargo doc and the mdbook command), but I think we should avoid creating an artifact for the release task. The artifact could be too big in terms of size. So the best thing to do is the commit above in my opinion.

@marco-c
Copy link
Collaborator

marco-c commented Jun 11, 2020

I agree on the documentation task (for cargo doc and the mdbook command), but I think we should avoid creating an artifact for the release task. The artifact could be too big in terms of size. So the best thing to do is the commit above in my opinion.

We should check how big it is, I would expect it to be relatively small given that the documentation is mostly text.

@Luni-4
Copy link
Collaborator Author

Luni-4 commented Jun 11, 2020

We should check how big it is, I would expect it to be relatively small given that the documentation is mostly text.

Ok, checked the size: 1,7MB. But why can't we run the script in the release task? After all, we are uploading the output of mdbook as Github Pages. Since mdbook and cargo doc commands will be already tested in the documentation task, perhaps it's a boilerplate loading the artifact and run the script again

@marco-c
Copy link
Collaborator

marco-c commented Jun 11, 2020

Ok, checked the size: 1,7MB. But why can't we run the script in the release task? After all, we are uploading the output of mdbook as Github Pages. Since mdbook and cargo doc commands will be already tested in the documentation task, perhaps it's a boilerplate loading the artifact and run the script again

It's better to have logical separation between the tasks: one task does the build (in this case documentation build), another task (very lightweight) deploys it (in this case on gh-pages).
If you run the build command on the release task, you'll make it slower (as you need to rebuild) and heavier (as you need the dependencies to build).

@Luni-4 Luni-4 force-pushed the deploy-documentation branch from 7d86ee2 to 40243a1 Compare June 12, 2020 08:42
.taskcluster.yml Outdated Show resolved Hide resolved
@Luni-4 Luni-4 force-pushed the deploy-documentation branch 5 times, most recently from f1b3f28 to 1cef10b Compare June 12, 2020 13:11
@Luni-4 Luni-4 force-pushed the deploy-documentation branch 7 times, most recently from d6be04d to 78bc2a4 Compare June 19, 2020 14:08
@Luni-4 Luni-4 force-pushed the deploy-documentation branch from 78bc2a4 to 7c8ac93 Compare June 19, 2020 14:10
@Luni-4 Luni-4 requested a review from marco-c June 19, 2020 14:10
@Luni-4
Copy link
Collaborator Author

Luni-4 commented Jun 22, 2020

@marco-c
This PR is now ready

.taskcluster.yml Outdated Show resolved Hide resolved
.taskcluster.yml Outdated Show resolved Hide resolved
.taskcluster.yml Outdated Show resolved Hide resolved
@Luni-4 Luni-4 requested a review from marco-c June 22, 2020 09:15
.taskcluster.yml Outdated Show resolved Hide resolved
@Luni-4 Luni-4 requested a review from marco-c June 22, 2020 11:33
Copy link
Collaborator

@marco-c marco-c left a comment

Choose a reason for hiding this comment

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

Thanks!

@marco-c marco-c merged commit c0adfcd into mozilla:master Jun 22, 2020
@Luni-4 Luni-4 deleted the deploy-documentation branch June 22, 2020 16:11
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