chore: add this month in forest reminder #6288

LesnyRumcajs · 2025-12-04T12:29:32Z

Summary of changes

Changes introduced in this pull request:

added a reminder so that we don't forget about the monthly This Month in Forest.

Reference issue to close (if applicable)

Closes #6284

Change checklist

I have performed a self-review of my own code,
I have made corresponding changes to the documentation. All new code adheres to the team's documentation standards,
I have added tests that prove my fix is effective or that my feature works (if possible),
I have made sure the CHANGELOG is up-to-date. All user-facing changes should be reflected in this document.

Summary by CodeRabbit

Chores
- Added an automated monthly reminder that creates a structured checklist on the 1st of every month to streamline PR/issue review, contributor recognition, and cross-posting to discussions and Slack.
Documentation
- Added a ready-made monthly reminder template with preparation and post-publication steps (review PRs/issues, gather metrics, draft for feedback, publish and pin).

_{✏️ Tip: You can customize this high-level summary in your review settings.}

coderabbitai · 2025-12-04T12:29:51Z

Walkthrough

Adds automation to create a monthly "This Month in Forest" reminder issue: a new Markdown checklist template and a GitHub Actions workflow that dispatches (manual) and runs monthly (1st) to create an issue from that template.

Changes

Cohort / File(s)	Change Summary
Monthly reminder automation `.github/THIS_MONTH_IN_FOREST_REMINDER_TEMPLATE.md`, `.github/workflows/this-month-in-forest-reminder.yml`	Added a Markdown template with YAML front matter and a structured checklist for preparing/publishing the monthly "This Month in Forest" post. Added a GitHub Actions workflow triggered by `workflow_dispatch` and a cron schedule (1st of each month) that uses `JasonEtco/create-an-issue@v2` to create an issue from the template using `GITHUB_TOKEN`.

Sequence Diagram(s)

sequenceDiagram
  autonumber
  participant Scheduler as Cron (GitHub Actions)
  participant Workflow as Workflow Dispatcher
  participant Runner as Actions Runner (ubuntu-24.04-arm)
  participant Action as create-an-issue@v2
  participant GitHub as GitHub Issues API / Repo

  Scheduler->>Workflow: Trigger on 1st of month / manual dispatch
  Workflow->>Runner: Start job (checkout repo)
  Runner->>Action: Invoke create-an-issue with template path + GITHUB_TOKEN
  Action->>GitHub: POST issue (template content -> new issue)
  GitHub-->>Action: Issue created (response)
  Action-->>Runner: Success/Failure status
  Runner-->>Workflow: Job completes

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Verify cron schedule targets the 1st of each month (timezone considerations).
Confirm the workflow references the exact template path .github/THIS_MONTH_IN_FOREST_REMINDER_TEMPLATE.md.
Check GITHUB_TOKEN scope is appropriate for creating issues and no additional permissions are required.
Quick review of template content for accuracy and required checklist items.

Suggested reviewers

hanabi1224
elmattic

Pre-merge checks and finishing touches

✅ Passed checks (5 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The title 'chore: add this month in forest reminder' accurately summarizes the main change: adding a reminder mechanism for the monthly 'This Month in Forest' post.
Linked Issues check	✅ Passed	The PR successfully implements the primary objective from issue #6284: creating a cronjob workflow reminder to prompt creation of the 'This Month in Forest' post with proper guidelines, and the workflow is created and functioning.
Out of Scope Changes check	✅ Passed	All changes are directly related to the linked issue #6284 objective of creating a workflow reminder. No out-of-scope changes are present.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✨ Finishing touches

🧪 Generate unit tests (beta)

Create PR with unit tests
Post copyable unit tests in a comment
Commit unit tests in branch this-month-in-forest-cron

📜 Recent review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 15405e3 and 01c809a.

📒 Files selected for processing (1)

.github/THIS_MONTH_IN_FOREST_REMINDER_TEMPLATE.md (1 hunks)

🧰 Additional context used

🧠 Learnings (1)

📓 Common learnings

Learnt from: LesnyRumcajs
Repo: ChainSafe/forest PR: 5907
File: src/rpc/methods/state.rs:523-570
Timestamp: 2025-08-06T15:44:33.467Z
Learning: LesnyRumcajs prefers to rely on BufWriter's Drop implementation for automatic flushing rather than explicit flush() calls in Forest codebase.

⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (8)

GitHub Check: tests
GitHub Check: tests-release
GitHub Check: Build Ubuntu
GitHub Check: cargo-publish-dry-run
GitHub Check: Build MacOS
GitHub Check: All lint checks
GitHub Check: Build forest binaries on Linux AMD64
GitHub Check: Check

🔇 Additional comments (2)

.github/THIS_MONTH_IN_FOREST_REMINDER_TEMPLATE.md (2)

1-26: Template looks good — past capitalization issue has been resolved.

The template structure is well-organized with clear sections, proper YAML frontmatter, and actionable checklist items. The capitalization of "GitHub Discussions" on line 23 has been corrected from the previous review.

1-26: Verify the workflow file references this template correctly.

Ensure that the corresponding GitHub Actions workflow (.github/workflows/this-month-in-forest-reminder.yml) properly references this template file and that the JasonEtco/create-an-issue@v2 action is configured to use the correct template path.

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

coderabbitai

Actionable comments posted: 1

🧹 Nitpick comments (1)

.github/workflows/this-month-in-forest-reminder.yml (1)
9-9: Rename the job to reflect its actual purpose.

The job name checkpoint_issue appears to be copy-pasted from another workflow and is misleading. It should reflect that this job creates a monthly reminder issue.

Consider renaming the job to something more descriptive:
-  checkpoint_issue:
+  create_reminder_issue:
Or alternatively, if aligning with Forest conventions, use a name like create_forest_reminder_issue.

📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 0c7718e and 15405e3.

📒 Files selected for processing (2)

.github/THIS_MONTH_IN_FOREST_REMINDER_TEMPLATE.md (1 hunks)
.github/workflows/this-month-in-forest-reminder.yml (1 hunks)

🧰 Additional context used

🧠 Learnings (1)

📓 Common learnings

Learnt from: LesnyRumcajs
Repo: ChainSafe/forest PR: 5907
File: src/rpc/methods/state.rs:523-570
Timestamp: 2025-08-06T15:44:33.467Z
Learning: LesnyRumcajs prefers to rely on BufWriter's Drop implementation for automatic flushing rather than explicit flush() calls in Forest codebase.

🪛 LanguageTool

.github/THIS_MONTH_IN_FOREST_REMINDER_TEMPLATE.md

[uncategorized] ~23-~23: The official name of this software platform is spelled with a capital “H”.
Context: ...lish it to the [Forest announcements on Github Discussions](https://github.com/ChainSa...

(GITHUB)

⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (7)

GitHub Check: Build Ubuntu
GitHub Check: Build MacOS
GitHub Check: cargo-publish-dry-run
GitHub Check: tests-release
GitHub Check: tests
GitHub Check: All lint checks
GitHub Check: Build forest binaries on Linux AMD64

🔇 Additional comments (3)

.github/workflows/this-month-in-forest-reminder.yml (2)

10-10: Verify the runner choice is appropriate for this workflow.

The workflow uses ubuntu-24.04-arm, an ARM-based runner. For a simple workflow that only checks out code and creates a GitHub issue, this is functional but consider whether this runner type is necessary or if ubuntu-latest would be more broadly available.

3-17: Workflow structure looks good.

The trigger configuration (both manual dispatch and scheduled monthly) aligns well with the PR objectives. The cron schedule 0 0 1 * * will trigger on the 1st of every month at 00:00 UTC, and the action integration with the template file is correct. The use of GITHUB_TOKEN for authentication is appropriate.

.github/THIS_MONTH_IN_FOREST_REMINDER_TEMPLATE.md (1)

1-26: Template structure and content are well-crafted.

The issue template provides clear guidance with a logical flow: introductory context, pre-gathering considerations, and post-gathering actionable checklist items. The informational lines (12-16) effectively guide contributors on what to look for, followed by concrete checkbox items (20-26) that track completion. The label "Type: Task" is appropriate for a recurring team task reminder. The links to GitHub Discussions and Slack channels are helpful for directing contributors to publication targets.

.github/THIS_MONTH_IN_FOREST_REMINDER_TEMPLATE.md

Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>

chore: add this month in forest reminder

15405e3

LesnyRumcajs requested a review from a team as a code owner December 4, 2025 12:29

LesnyRumcajs requested review from akaladarshi and hanabi1224 and removed request for a team December 4, 2025 12:29

akaladarshi previously approved these changes Dec 4, 2025

View reviewed changes

coderabbitai bot reviewed Dec 4, 2025

View reviewed changes

.github/THIS_MONTH_IN_FOREST_REMINDER_TEMPLATE.md Outdated Show resolved Hide resolved

Update .github/THIS_MONTH_IN_FOREST_REMINDER_TEMPLATE.md

01c809a

Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>

LesnyRumcajs dismissed akaladarshi’s stale review via 01c809a December 4, 2025 12:36

LesnyRumcajs enabled auto-merge December 4, 2025 12:36

akaladarshi approved these changes Dec 4, 2025

View reviewed changes

hanabi1224 approved these changes Dec 4, 2025

View reviewed changes

LesnyRumcajs added this pull request to the merge queue Dec 4, 2025

Merged via the queue into main with commit b3005fe Dec 4, 2025
51 checks passed

LesnyRumcajs deleted the this-month-in-forest-cron branch December 4, 2025 13:24

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

chore: add this month in forest reminder #6288

chore: add this month in forest reminder #6288

Uh oh!

LesnyRumcajs commented Dec 4, 2025 •

edited by coderabbitai bot

Loading

Uh oh!

coderabbitai bot commented Dec 4, 2025 •

edited

Loading

Uh oh!

coderabbitai bot left a comment

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

chore: add this month in forest reminder #6288

chore: add this month in forest reminder #6288

Uh oh!

Conversation

LesnyRumcajs commented Dec 4, 2025 • edited by coderabbitai bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary of changes

Reference issue to close (if applicable)

Other information and links

Change checklist

Summary by CodeRabbit

Uh oh!

coderabbitai bot commented Dec 4, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Walkthrough

Changes

Sequence Diagram(s)

Estimated code review effort

Suggested reviewers

Pre-merge checks and finishing touches

Uh oh!

coderabbitai bot left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

LesnyRumcajs commented Dec 4, 2025 •

edited by coderabbitai bot

Loading

coderabbitai bot commented Dec 4, 2025 •

edited

Loading