CI: Add two columns for the main and nightly workflows to the "Available plugins" table in README.md #509
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
sip-21
force-pushed
the
add-ci-workflow-columns-in-readme
branch
from
ea70648
to
d35c346
Compare
sip-21
changed the title
chrisguida
reviewed
Mar 30, 2024
README.md
Outdated
| | [watchtower][watchtower-client] | Watchtower client for The Eye of Satoshi | | ||
| | [webhook][webhook] | Dispatches webhooks based from [event notifications][event-notifications] | | ||
| | [zmq][zmq] | Publishes notifications via [ZeroMQ][zmq-home] to configured endpoints | | ||
| | Name | Short description | Main  | Nigthly  | |
There was a problem hiding this comment.
Suggested change
| | Name | Short description | Main  | Nigthly  | | |
| | Name | Short description | Main  | Nightly  | |
There was a problem hiding this comment.
I would change both Main and Nightly to CLN. So it would read "CLN v24.02.1" and "CLN master" right now. I think this makes it way more clear.
sip-21
force-pushed
the
add-ci-workflow-columns-in-readme
branch
from
d35c346
to
eb19a7f
Compare
|
@sip-21 is this still good to go? Thinking it's had enough review time? |
Yes, it has been hanging there for quite some some time now. I noticed, though, there is a merge conflict now as README.md had an update a few days ago. Also as a reminde before triggering the mergebot, these preparation steps need to be done:
|
sip-21
force-pushed
the
add-ci-workflow-columns-in-readme
branch
from
eb19a7f
to
3ab9ee0
Compare
chrisguida
previously requested changes
Apr 19, 2024
chrisguida
reviewed
Apr 19, 2024
.ci/test.py
Outdated
|
|
||
| def configure_git(): | ||
| subprocess.run(["git", "config", "--global", "user.email", '"[email protected]"']) | ||
| subprocess.run(["git", "config", "--global", "user.name", '"lightningd"']) |
There was a problem hiding this comment.
Clarify that this is an automated / bot user
There was a problem hiding this comment.
Added a comment: a4cc954
chrisguida
reviewed
Apr 19, 2024
chrisguida
reviewed
Apr 19, 2024
sip-21
force-pushed
the
add-ci-workflow-columns-in-readme
branch
from
5537199
to
ea54b9f
Compare
sip-21
force-pushed
the
add-ci-workflow-columns-in-readme
branch
from
8b378d6
to
26c1d65
Compare
sip-21
changed the title
chrisguida
approved these changes
Jun 1, 2024
There was a problem hiding this comment.
Looks great, I'm super psyched for this feature. Great work!! 🚀
ACK 26c1d65
sip-21
changed the title
vincenzopalazzo
approved these changes
Jun 1, 2024
Merged
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR adds two columns for the
mainandnightlyworkflows to the "Available plugins" table in README.md that displays badges indicating plugins' test results:master. Workflow runs triggered by pull requests are ignored.If a plugin has no tests, no badges are displayed.
During the above workflow runs various data is generated and saved to the .badges directory of the (to be created)
badgesbranch. It is a two step process:build-and-testandnightly-build-and-testjobs) the test result ("passed" or "failed") for each plugin and Python version is saved to a separate file, e.g. .badges/gather_data/main/backup/python3.12.txt.gatherjob the data from step 1 is collected and written to JSON files , e.g. .badges/backup_main.json and .badges/backup_nightly.json. If the JSON data for a plugin has changed it is committed and pushed. This JSON data is then exposed through GitHub Pages which allows for the badges to be rendered dynamically.Notes:
badgesneeds to be created manually and then GitHub pages need to be configured withSourceset toDeploy from a branchand withBranchset tobadges.Codetab. This may have been due to the browser still caching an older badge.Display of badges with the
holdinvoiceplugin CLN master tests currently failing.This PR also re-enables CI tests for the
feeadjusterplugin by removing it from the list of excluded directories which it was added to erroneously while being unarchived.Corresponding issue: #494