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 basic CI Release Documentation #2232

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Add basic CI Release Documentation #2232

wants to merge 2 commits into from

Conversation

ziyiwu9494
Copy link
Contributor

Readme and template for documenting how to create a new CI file for releases. Right now the process must be done manually.

@ziyiwu9494 ziyiwu9494 requested a review from a team as a code owner February 11, 2021 02:21
@ziyiwu9494 ziyiwu9494 requested review from krzentner and removed request for a team February 11, 2021 02:21
@mergify mergify bot requested review from a team, gitanshu and maliesa96 and removed request for a team February 11, 2021 02:21
@ziyiwu9494 ziyiwu9494 closed this Feb 11, 2021
@@ -0,0 +1,28 @@
# CI
Copy link
Member

Choose a reason for hiding this comment

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

Can you put these docs into ReadTheDocs (in docs/) instead?

@@ -0,0 +1,410 @@
name: Garage CI <Release Version>
Copy link
Member

Choose a reason for hiding this comment

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

I don't think this is the best place for this file, since it will probably get picked up by GH actions. Is this just a copy (mostly) of the existing release files? In that case, not sure we need it.

Copy link
Contributor Author

@ziyiwu9494 ziyiwu9494 Mar 15, 2021

Choose a reason for hiding this comment

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

Hi! I'm reopening this because I don't think we'll be changing the Github Actions workflows any further for some time. The template is closer to a copy of the Release CI but with updates (doctest, etc.). I feel like it would just make the process more foolproof than it would be if there was no file at all that could be made into a new release ci file with the obvious edits. It does fail GH actions though. Do you think there's a better place to put it?

@ziyiwu9494 ziyiwu9494 reopened this Mar 15, 2021
@codecov
Copy link

codecov bot commented Mar 15, 2021

Codecov Report

Merging #2232 (942566a) into master (7ecab12) will decrease coverage by 0.66%.
The diff coverage is n/a.

Impacted file tree graph

@@            Coverage Diff             @@
##           master    #2232      +/-   ##
==========================================
- Coverage   91.84%   91.18%   -0.67%     
==========================================
  Files         242      201      -41     
  Lines       17456    10977    -6479     
  Branches     2537     1371    -1166     
==========================================
- Hits        16033    10009    -6024     
+ Misses       1057      705     -352     
+ Partials      366      263     -103     
Impacted Files Coverage Δ
src/garage/sampler/utils.py 0.00% <0.00%> (-77.05%) ⬇️
src/garage/torch/algos/pearl.py 48.64% <0.00%> (-31.00%) ⬇️
src/garage/envs/multi_env_wrapper.py 79.51% <0.00%> (-14.60%) ⬇️
src/garage/tf/policies/policy.py 77.77% <0.00%> (-13.53%) ⬇️
src/garage/sampler/env_update.py 82.92% <0.00%> (-13.08%) ⬇️
src/garage/tf/algos/erwr.py 44.44% <0.00%> (-12.70%) ⬇️
src/garage/experiment/task_sampler.py 75.86% <0.00%> (-7.58%) ⬇️
src/garage/np/_functions.py 77.39% <0.00%> (-7.01%) ⬇️
...rage/tf/optimizers/conjugate_gradient_optimizer.py 81.90% <0.00%> (-6.57%) ⬇️
src/garage/tf/_functions.py 68.85% <0.00%> (-5.98%) ⬇️
... and 150 more

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 7ecab12...942566a. Read the comment docs.

@krzentner krzentner removed their request for review September 3, 2021 19:15
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.

2 participants