https://github.com/fastruby/blogcop

Blogcop is GitHub bot made with Sinatra that helps you manage the outdated articles of your Jekyll blog
https://github.com/fastruby/blogcop

bot github-app jekyll ruby sinatra

Last synced: 4 days ago
JSON representation

Blogcop is GitHub bot made with Sinatra that helps you manage the outdated articles of your Jekyll blog

• Host: GitHub
• URL: https://github.com/fastruby/blogcop
• Owner: fastruby
• Created: 2019-09-17T00:23:09.000Z (about 5 years ago)
• Default Branch: main
• Last Pushed: 2023-09-11T19:59:39.000Z (about 1 year ago)
• Last Synced: 2023-09-12T04:39:25.442Z (about 1 year ago)
• Topics: bot, github-app, jekyll, ruby, sinatra
• Language: Ruby
• Homepage: https://github.com/marketplace/outdated-article
• Size: 43 KB
• Stars: 6
• Watchers: 9
• Forks: 1
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • Code of conduct: CODE_OF_CONDUCT.md
  • Codeowners: CODEOWNERS

Awesome Lists containing this project

README

        
# Blogcop

Blogcop is a simple GitHub bot made with [Sinatra](http://sinatrarb.com/) that helps you manage the outdated articles of your [Jekyll](https://jekyllrb.com) blog.

Check out the article on the [OmbuLabs blog](https://www.ombulabs.com/blog) for more details.

## Installation

The bot is available to install on the [GitHub Marketplace](https://github.com/marketplace/outdated-article).

## Development

### Requirements

- Ruby >= 2.2.0

- Have a [GitHub app](https://developer.github.com/apps/building-github-apps/creating-a-github-app/) with these settings:

  - Repository permissions

    - Contents (Read & Write)

    - Issues (Read & Write)

    - Pull requests (Read & Write)

  - Subscribe to events

    - Issues

    - Pull request

    - Push

### Steps

1. Clone the repository to your local machine: `git clone [email protected]:ombulabs/blogcop.git`

2. Go to the new directory and run `bundle`

3. Create a copy of the environment variables: `cp .env.sample .env`

4. Add your GitHub App's private key, app ID, and webhook secret to the `.env` file.

5. Run `ruby server.rb`

## Task

To check blogposts on all installations on demand, run the command `ruby check_outdated_posts.rb`. This can be triggered with a cronjob.

## Testing

run `ruby tests.rb`

## Contributing

Bug reports and pull requests are welcome on GitHub at [https://github.com/fastruby/blogcop](https://github.com/fastruby/blogcop). This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.

When Submitting a Pull Request:

* If your PR closes any open GitHub issues, please include `Closes #XXXX` in your comment

* Please include a summary of the change and which issue is fixed or which feature is introduced.

* If changes to the behavior are made, clearly describe what changes.

* If changes to the UI are made, please include screenshots of the before and after.

## Support

You can contact [email protected] if you have any question about this repository.