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

Updated stars and redirects via awesome-stars-bot #530

Closed
wants to merge 1 commit into from
Closed

Updated stars and redirects via awesome-stars-bot #530

wants to merge 1 commit into from

Conversation

giphybot
Copy link

This Pull Request has been generated automatically by awesome-stars-bot, which was created by @ColinEberhardt. The aim of this bot is to improve the overall standard of the various GitHub-based 'awesome' lists.

For questions / comments regarding the bot, or to have your awesome repo removed from the list, please add an issue here:

https://github.com/ColinEberhardt/awesome-stars-bot

Currently the bot does the following:

  • Adds a star count for repos, this helps people find popular projects (especially useful for big lists!)
  • Resolves redirects, updating the project / org name when a redirect is found.
  • Removes links that returns 404s (please double check these deletions before merging in case it is a temporary issue)

More features are on the way!

@dkhamsing
Copy link
Collaborator

dkhamsing commented Apr 19, 2016

@awesome-stars-bot @ColinEberhardt this is great although when bootstrapping this process, the diff cannot be viewed in the pull request.. this is problematic if there are deletions..

We can look at the fork https://github.com/awesome-stars-bot/awesome-swift but the deletion issue remains

Could you generate a table summary with updates and deletions?

How do we get the bot to run again? Is there a plan for the data to not be stale

@ColinEberhardt
Copy link
Contributor

Thanks @dkhamsing - I tested on smaller repos, and the diffs were visible. I'll look into this and get back to you!

For this repo there were 2x broken links and 5x redirects, but yes, the diffs need to work to allow for review.

Regarding running the bot again, I'm planning on having this run as a scheduled task.

Anyhow, hope you don't mind me beta testing this bot on your repo? :-)

@dkhamsing
Copy link
Collaborator

@ColinEberhardt thanks for the quick response

Would you run this once a month? what did you have in mind

Since this is just one pull request, it's not a big deal 😉 However beware that GitHub has a strict policy against bots, they prefer that such services are opt in but it's sort of a gray area

@ColinEberhardt
Copy link
Contributor

I'd plan to run the bot over each 'awesome' list once every couple of weeks. It's not something that would need to be run terribly frequently. Although if a list-maintainer wanted to, they could run it via Travis.

Thanks for the heads-up about GitHub bots, I'm aware that a number exist but haven't checked the policy. You're right, it is a bit of a gray area. I think the important thing is to make sure the bot is doing Good Things™ - and is not annoying users.

I'll look into creating a table which summarises the updates. I'll test on my fork before creating a new PR.

Just for my benefit, do you think this bot would be useful for you as a lis maintainer? And do you like the added star-counts?

Thanks :-)

@dkhamsing
Copy link
Collaborator

dkhamsing commented Apr 20, 2016

Colin
I think deleting could be a sensitive issue for these projects, I'd suggest delete to be a separate pull or configurable.. somehow

@ColinEberhardt
Copy link
Contributor

You make a very good point there. I'm probably trying to do too much in one go, and before the bot has gained trust.

What I'll do is restrict the bots functionality to just removing broken links in the first iteration, then run it for a while until people are happy with it before doing 'added value' stuff like adding stars.

Regarding configuration, I was thinking of having a .awesome-bot file which people could add to their repo:

{
  addStars: true,
  removeDeadLinks: true,
  rewriteRedirect: true
}

That way you could opt-in or out to certain behaviour.

@matteocrippa
Copy link
Owner

@ColinEberhardt nice bot, as @dkhamsing suggested a configuration would be really interesting, even probably we need to manage formatting of the stars in a different way.

I'm saying this because at this very moment this repo has a mobile app that scrape the MD file format to generate categories and contents, so we have to modify the scraper according a new regex in order to have it working fine.

We should force submitters to add the star when they add a brand new repo or we manage to have it working in a different way... as soon as I go back home I'll try to think how to deal w/ it.

Probably a new param like formatting in .awesome-bot would be interesting.

@ColinEberhardt
Copy link
Contributor

@matteocrippa - thanks for the feedback, glad to hear that you like the connect :-)

As discussed with @dkhamsing I think I'm trying to do too much in one go here. I'm just going to concentrate on cleaning up broken links in the first iteration, making sure i get the automation right and that the bot is sufficiently 'friendly' in order to build up trust.

@giphybot giphybot closed this Apr 20, 2016
@dkhamsing
Copy link
Collaborator

Matteo
Do you think we should change the list to be based on another format (json?) and have the readme be auto generated? This would help the app (and potential website)

Most people are used to editing the readme though

@matteocrippa
Copy link
Owner

json would be awesome for the app :) but probably for maintenance and to avoid any error, it would be interesting to have a bot that triggered on json update generates the readme file and ask for a PR

@dkhamsing
Copy link
Collaborator

dkhamsing commented Apr 20, 2016

yeah would be an interesting project.. this new format would allow a project to be in more categories automatically (although that is not really an issue now), will create another issue to discuss

thx

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.

None yet

4 participants