Page MenuHomeSoftware Heritage
Differential D1461

Fix outdated README for listers and improve formatting
ClosedPublic
Actions

Authored by anlambert on May 13 2019, 3:26 PM.

Details

Reviewers
ardumont
douardda
Commits
rDLS7d192a2f1b45: README.md: Fix outdated instructions and improve formatting
rDLS977d2459c3c2: Remove references to no more used lister_db_url conf entry
Summary

While working on the Phabricator lister with @nahimilega,
I found out that the README for swh-lister was quite outdated
(https://forge.softwareheritage.org/D1365#32391).

That diff updates the README with up to date instructions
for configuring / running a lister.

I also removed a deprecated configuration entry that is no more used
in the current code.

Diff Detail

Repository
rDLS Listers
Branch
fix-outdated-README
Lint
No Linters Available
Unit
No Unit Test Coverage
Build Status
Buildable 5689
Build 7772: tox-on-jenkinsJenkins
Build 7771: arc lint + arc unit

Event Timeline

anlambert created this revision.May 13 2019, 3:26 PM
swh-public-ci added a comment.May 13 2019, 3:29 PM

Build is green
See https://jenkins.softwareheritage.org/job/DLS/job/tox/108/ for more details.

Harbormaster completed remote builds in B5689: Diff 4790.May 13 2019, 3:29 PM
nahimilega added inline comments.May 13 2019, 3:30 PM
README.md
150

I think here you should import npm lister

anlambert added inline comments.May 13 2019, 3:34 PM
README.md
150

Right!

anlambert updated this revision to Diff 4791.May 13 2019, 3:35 PM

Fix typo in README

swh-public-ci added a comment.May 13 2019, 4:06 PM

Build is green
See https://jenkins.softwareheritage.org/job/DLS/job/tox/109/ for more details.

Harbormaster completed remote builds in B5690: Diff 4791.May 13 2019, 4:06 PM
ardumont added a reviewer: douardda.May 14 2019, 9:58 AM
ardumont accepted this revision.May 14 2019, 10:02 AM

Thanks for the update.
Sounds good to me.

I added @douardda as reviewer as he is working on the lister initialization/registering part (which might land, thus changing this again ;)

Cheers,

README.md
116

I used the previous format so that we could easily copy/paste but meh ;)

This revision is now accepted and ready to land.May 14 2019, 10:02 AM
anlambert added inline comments.May 14 2019, 10:48 AM
README.md
116

Ack, will turn those snippets into a script form rather than a REPL session

anlambert updated this revision to Diff 4794.May 14 2019, 11:00 AM

Update: Turn Python code snippets from REPL forms to script ones to ease copy / paste

swh-public-ci added a comment.May 14 2019, 11:03 AM

Build is green
See https://jenkins.softwareheritage.org/job/DLS/job/tox/111/ for more details.

Harbormaster completed remote builds in B5694: Diff 4794.May 14 2019, 11:03 AM
Closed by commit rDLS977d2459c3c2: Remove references to no more used lister_db_url conf entry (authored by anlambert). · Explain WhyMay 14 2019, 1:07 PM
This revision was automatically updated to reflect the committed changes.

Revision Contents
Changeset List

PathSize
277 lines
bin/
2 lines
swh/
lister/
1 line

Diff 4790

View Options

README.md

Loading...
View Options

bin/ghlister

Loading...
View Options

swh/lister/cli.py

Loading...
About · Developer information · Legal