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

Report creation script #61

Merged
merged 1 commit into from
Nov 17, 2023
Merged

Report creation script #61

merged 1 commit into from
Nov 17, 2023

Conversation

PaulFarault
Copy link
Collaborator

@PaulFarault PaulFarault commented Oct 28, 2023

Provide a script to easily create new meeting notes reports.

Usage

npm run reportinit

Result

Create a yymmdd-contributors.md file on a new yymmdd-contributors-report branch containing a template populated with the pending PRs. For example:

---
type: contributors
date: 2023-10-28
description: |
<main topics of the meeting>
---

# TDP contributors meeting notes

<!-- general notes -->

## Pull Requests

Weekly review of open PRs (in chronological order):

- [tdp-ui#198](https://github.com/TOSIT-IO/tdp-ui/pull/198): <!-- status of "Release automation" -->
- [tdp-collection#745](https://github.com/TOSIT-IO/tdp-collection/pull/745): <!-- status of "WIP: 612 yarn timeline v2" -->
- [tdp-ui#210](https://github.com/TOSIT-IO/tdp-ui/pull/210): <!-- status of "chore: add dev environment without auth" -->

## Open topics

<!-- open topics -->

package.json Outdated
@@ -79,6 +79,7 @@
"postinstall": "husky install",
"prepack": "pinst --disable",
"postpack": "pinst --enable",
"init-report": "node scripts/initReport.mjs",
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

  1. Scripts are located inside bin
  2. the entry point shall be the foundation of a future scalable API without backward incompatibilities, the entry point shall be generatic, eg npx tdp <command> <args> (use Shell.js)
  3. the command, initReport shall accept additional commands as part of a more complex API, report init and not init report

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

  1. Scripts are located inside bin

All other TOSIT-IO project use a scripts directory. I think it's best to do the same here.

  1. the entry point shall be the foundation of a future scalable API without backward incompatibilities, the entry point shall be generatic, eg npx tdp (use Shell.js)
  2. the command, initReport shall accept additional commands as part of a more complex API, report init and not init report

This is a simple script that I share for convenience. If we want to build a whole CLI I suggest we do it in a next iteration.

I renamed the script to reportinit.

scripts/initReport.mjs Outdated Show resolved Hide resolved
scripts/initReport.mjs Outdated Show resolved Hide resolved
scripts/initReport.mjs Outdated Show resolved Hide resolved
scripts/initReport.mjs Outdated Show resolved Hide resolved
scripts/initReport.mjs Outdated Show resolved Hide resolved
scripts/initReport.mjs Outdated Show resolved Hide resolved
scripts/initReport.mjs Outdated Show resolved Hide resolved
scripts/initReport.mjs Outdated Show resolved Hide resolved
scripts/initReport.mjs Outdated Show resolved Hide resolved
@PACordonnier
Copy link
Member

Thanks @PaulFarault, I'm not able to review code but feature is very useful !

@PaulFarault PaulFarault force-pushed the report-script branch 4 times, most recently from e6e4efb to 2d9b33d Compare November 10, 2023 13:13
@rpignolet rpignolet merged commit a372c0f into master Nov 17, 2023
1 check passed
@rpignolet rpignolet deleted the report-script branch November 17, 2023 14:12
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