Discourse Yearly Review

:discourse2: Summary Discourse Yearly Review creates a topic that summarizes the previous year’s forum activity. You can see the latest example for here on Meta in 2021: The Year in Review
:hammer_and_wrench: Repository Link https://github.com/discourse/discourse-yearly-review
:open_book: Install Guide How to install plugins in Discourse


The topic displays data in two sections - users and topics.

The users section includes:

  • Most Time Reading
  • Most Topics Created
  • Most Replies Created
  • Most Replied to
  • Most Likes Given
  • Most Likes Received
  • Most Visits
  • Users who have been granted a featured badge (the badge is set by the yearly review featured badge Site Setting

The topics section includes:

  • Most Read
  • Most Liked
  • Most Replied to
  • Most Popular
  • Most Bookmarked

The plugin sets thresholds for deciding which topics to display. There need to be a minimum of 10 likes or replies, 5 bookmarks, a score of 10, or one hour’s read time before a topic will be displayed. Categories used in this section are taken from the 5 best public categories that have been set in the yearly review categories Site Setting. If this setting is not configured, the 5 best public categories from the forum will be chosen. “Best” is determined by the category topics_year count. Topics created in read restricted categories are not included in the topics section.

The plugin has a yearly review exclude staff setting. It is enabled by default. When enabled, staff members are excluded from the users section and topics created by staff are excluded from the topics section.

The featured badge is set by the yearly review featured badge setting. A maximum of 15 badge users are displayed. If more than 15 users have been granted the badge, a link to the badge’s page is displayed. If the yearly review featured badge is not configured, this section will not be displayed.

The topic is published automatically through a background job. The job checks that the plugin is enabled and that it is within the first ‘n’ days of the first month of the year (the ‘n’ number of days is currently set to 8, this may need to be bumped up.) It then checks to see if a topic with the title yearly_review.topic_title has already been published by the system user. If all checks pass, the topic is published to the category set in the yearly review publish category setting. If this is not configured, the topic will be published to the Uncategorized category.

If you wish to view the topic before making it public, set the yearly review publish category to a private category.

If you don’t want to wait for the background job to be run, you can publish the topic from the rails console with:

Jobs::YearlyReview.new.execute(force: true)

If you want to generate a report for a specific year just add review_year: 'year', e.g.:

Jobs::YearlyReview.new.execute(force: true, review_year: '2021')


  • The data is displayed in HTML tables. Tables are wrapped in div tags that have data-review-topic-users="true' and data-review-featured-topics="true" attributes. This allows the tables to be styled when they are displayed on Discourse. The styles are not copied when emails for the topics are created. Emails sent out for the topic don’t look great.

  • emojis in titles are not rendered in the featured topic links


  • 2020-11-20T06:00:00Z Added setting to include stats from private categories
  • 2020-11-20T06:00:00Z Added ability to turn off individual user stats



3 posts were split to a new topic: Include Chat stats in Discourse Yearly Review

Can this be run say Aug 2021 - Aug 2022, or for one month? Does it have to be a calendar year (Jan - Dec)?

1 Like

It can currently only be run for a calendar year. There have been a few requests to be able to create monthly review topics, so maybe that’s something that will be added in the future.


I’d be interested in a monthly version for sure.

1 Like

Looking at the topic it looks like you can already to this. Just run that every month. Provided you have access to the rails console.


Would that not just run a report of the last year to-to-date of the time it’s run?

1 Like

I’m thinking each month it would begin at 1 Jan and end at the month it’s run… maybe to the day/hour it’s run?
I don’t see it beginning before 1 January because it being a Yearly Review it’s coded to begin on 1 January and end on 31 December. I’m curious as to how it would treat the end date if it was before 31 December. It can’t run into the future.

1 Like