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

Documentation: PR Checklist or CI Actions for a date stamp update/reminder #184

Closed
bms63 opened this issue Jun 17, 2024 · 6 comments · Fixed by #222
Closed

Documentation: PR Checklist or CI Actions for a date stamp update/reminder #184

bms63 opened this issue Jun 17, 2024 · 6 comments · Fixed by #222
Assignees

Comments

@bms63
Copy link
Collaborator

bms63 commented Jun 17, 2024

Let us know where something needs a refresh or put your idea here!

A posts date usually is the date it was started by the author. We tend to forget to update the date once merged in and published. The blog then sorts the posts by date and our most recent post is buried.

Two possible solutions:

  1. A CI Action could be used to automatically change the date stamp of the file to the date of the Merge?
  2. A new checkbox in the PR Checklist for reviewers and creators of the post to check.

@StefanThoma maybe cool CI action to implement?

@bms63 bms63 changed the title Documentation: PR Checklist or CI Actions needs a data stamp reminder Documentation: PR Checklist or CI Actions for a data stamp update/reminder Jun 17, 2024
@StefanThoma
Copy link
Collaborator

StefanThoma commented Jun 17, 2024 via email

@bms63
Copy link
Collaborator Author

bms63 commented Jun 17, 2024

That sounds cool and practical to me!!

@bms63
Copy link
Collaborator Author

bms63 commented Jun 17, 2024

Honestly - I would hunt around in the marketplace and other repos as I am sure this has been solved already.

@manciniedoardo manciniedoardo self-assigned this Jul 22, 2024
@manciniedoardo
Copy link
Collaborator

I think it would be fairly easy to write an action for this, similar to #196. The only hurdle I can foresee is how to control when the action fires and when it does not, because we may have instances when we merge something onto main that isn't a blog post and so would not want the date of the latest blog post to be updated to the current date. What about if we mandate adding a codeword to the PR title (similar to "[Skip vbump]", so something like "[Update date]" so that every PR merged to main that uses this codeword then overwrites the timestamp on posts with the current date?

@StefanThoma
Copy link
Collaborator

You could also just check whether a new folder in posts/ was created in this branch, then you know a new blogpost was written, hence you should check the date. WDYT?

@manciniedoardo
Copy link
Collaborator

My thought was that it might be a bit obscure then. Asking users to put "[Blog post]" in their PR title at least then gives them a hint as to why to the date might be changing.

@manciniedoardo manciniedoardo changed the title Documentation: PR Checklist or CI Actions for a data stamp update/reminder Documentation: PR Checklist or CI Actions for a date stamp update/reminder Sep 5, 2024
manciniedoardo added a commit that referenced this issue Sep 12, 2024
manciniedoardo added a commit that referenced this issue Sep 12, 2024
manciniedoardo added a commit that referenced this issue Sep 12, 2024
* #184 first draft of post date auto update

* #184 fix workflow

* #184 fix workflow
manciniedoardo added a commit that referenced this issue Sep 12, 2024
manciniedoardo added a commit that referenced this issue Sep 12, 2024
* #184 first draft of post date auto update

* #184 fix workflow

* #184 fix workflow

* #184 move checking file
manciniedoardo added a commit that referenced this issue Sep 12, 2024
manciniedoardo added a commit that referenced this issue Sep 12, 2024
* #184 first draft of post date auto update

* #184 fix workflow

* #184 fix workflow

* #184 move checking file

* #184 rename job
manciniedoardo added a commit that referenced this issue Sep 12, 2024
manciniedoardo added a commit that referenced this issue Sep 12, 2024
@manciniedoardo manciniedoardo linked a pull request Sep 12, 2024 that will close this issue
9 tasks
gigikenneth pushed a commit that referenced this issue Sep 16, 2024
* #184 first draft of post date auto update

* #184 fix workflow

* #184 fix workflow

* #184 move checking file

* #184 rename job

* #184 Updated documentation

* #184 chore: styler

* Update R/create_blogpost.R

* Update R/readme.md

* #184 update workflow to actually push to main

* #184 added dependency for publishing job
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 a pull request may close this issue.

3 participants