-
Notifications
You must be signed in to change notification settings - Fork 310
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
base: master
Are you sure you want to change the base?
Conversation
.github/workflows/README.md
Outdated
@@ -0,0 +1,28 @@ | |||
# CI |
There was a problem hiding this comment.
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> |
There was a problem hiding this comment.
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.
There was a problem hiding this comment.
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?
Codecov Report
@@ 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
Continue to review full report at Codecov.
|
Readme and template for documenting how to create a new CI file for releases. Right now the process must be done manually.