https://github.com/pkgjs/meet
Create a meeting issue on a schedule
https://github.com/pkgjs/meet
automation github-actions markdown meetings nodejs
Last synced: 4 months ago
JSON representation
Create a meeting issue on a schedule
- Host: GitHub
- URL: https://github.com/pkgjs/meet
- Owner: pkgjs
- License: mit
- Created: 2020-04-19T17:24:18.000Z (about 6 years ago)
- Default Branch: main
- Last Pushed: 2026-02-11T17:08:08.000Z (5 months ago)
- Last Synced: 2026-02-14T17:14:23.595Z (5 months ago)
- Topics: automation, github-actions, markdown, meetings, nodejs
- Language: JavaScript
- Homepage:
- Size: 1.84 MB
- Stars: 12
- Watchers: 3
- Forks: 10
- Open Issues: 17
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Security: .github/SECURITY.md
Awesome Lists containing this project
README
# Schedule regularly occurring meetings via GitHub Issue
[](https://github.com/pkgjs/meet/actions?query=workflow%3Atest)
[](https://github.com/standard/standard)
Schedule meetings via a GitHub Action. Creates issues based on a schedule and template.
This repository is managed by the [Package Maintenance Working Group](https://github.com/nodejs/package-maintenance), see [Governance](https://github.com/nodejs/package-maintenance/blob/main/Governance.md).
## Usage
```yaml
name: Schedule team meetings
on:
schedule:
- cron: '0 0 * * * *' # Run daily at midnight UTC
jobs:
build:
runs-on: ubuntu-latest
steps:
- uses: pkgjs/meet@v1
with:
token: ${{ secrets.GITHUB_TOKEN }}
schedules: 2020-04-02T17:00:00[America/Chicago]/P1D # Every 1 day from 2020-04-02 at 5PM Chicago time
createWithin: P2D # Create issue 2 days before the scheduled meeting
```
### Github Action Inputs
The meeting schedule, issue, etc can be configured with inputs to this action.
- `token`: (required) The token from the action for calling to the GitHub API.
- `schedules`: (required) The meeting schedules. Supports timezone identifiers (e.g., `2020-04-02T17:00:00[America/Chicago]/P7D`) or UTC (e.g., `2020-04-02T17:00:00Z/P7D`). Offset usage is not allowed. Default: `${now/P7D}` seven days from now
- `createWithin`: (required) The ISO-8601 duration for how soon before the meeting to create the issue. Default `P7D`
- `meetingLabels`: The labels to apply to issues generated by this GitHub Action for meetings. Default: `meeting`
- `agendaLabel`: Label to pull the agenda from. Default: `meeting-agenda`
- `issueTitle`: Template string for issue title. Default: `Meeting <%= date.toZonedDateTimeISO('UTC').toPlainDate().toString() %>`
- `issueTemplate`: The name of the issue template found in `.github/ISSUE_TEMPLATE`. Default: `meeting.md`
### Schedule format
The action supports [RFC 3339](https://datatracker.ietf.org/doc/html/rfc3339) timezone formats with two schedule options:
#### Timezone identifiers (recommended)
Use timezone identifiers for automatic DST handling:
```yaml
schedules: |
2020-04-02T17:00:00[America/Chicago]/P7D
2020-06-15T14:00:00[Europe/London]/P14D
```
This ensures meetings maintain the same wall-clock time throughout the year, automatically adjusting for daylight saving time transitions.
#### UTC time
Use UTC for absolute time scheduling:
```yaml
schedules: |
2020-04-02T17:00:00Z/P7D
```
#### Invalid formats
The following formats are **not supported** and will cause errors:
- `2020-04-02T17:00:00-06:00/P7D` (offset usage)
- `2020-04-02T17:00:00-06:00[America/Chicago]/P7D` (offset + timezone)
- `2020-04-02T17:00:00/P7D` (no timezone or UTC specified)
### Default Issue Template
The default issue template can be seen in the ISSUE_TEMPLATES directory, as [meeting.md](https://github.com/pkgjs/meet/blob/main/.github/ISSUE_TEMPLATE/meeting.md). Additionally, you can find example issues of the latest version via the closed issues that are the result of CI tests.
Our default template is based off of the Node.js project's practices around meetings, but changes and enhancements are welcome.
### Custom Issue Templates
If you don't want to use the default issue template, you can use a custom issue template by passing in the file name of it (presuming it lives in ISSUE_TEMPLATES).
You can use both our shorthand and JavaScript in your meeting templates.
## Template Data and Automatic Replacements
#### Autoreplacing Shorthand in Custom Meeting Templates
We provide some shorthand that you can use in your meeting templates. We'll automatically replace the shorthand with the relevant dynamic information.
If you'd like to see more shorthand available, we absolutely welcome PRs.
- **``**: The issue's title.
- **``**: The label for agenda items to be pulled from that you've defined in the Action's YAML configuration.
- **``**: The list of invitees you've defined in the Action's YAML configuration.
- **``**: The list of observers you've defined in the Action's YAML configuration.
- **``**: The meeting video call link
```md
## Title
## Agenda Items
Extracted from issues labelled with .
## Participants
- Invitees:
- Observers:
```
#### JavaScript in Your Custom Meeting Templates
You can include custom JavaScript in your custom meeting templates. We use [ejs](https://ejs.co/), so anything within an ejs tag will be parsed as JavaScript.
When using EJS templates for your meeting issues, the following data properties are available:
#### EJS Template Data
- **`date`**: `Temporal.Instant` - The date of the meeting, formatted using [Temporal](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Temporal) for timezone conversions and [Intl.DateTimeFormat](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl/DateTimeFormat) for locale-aware formatting.
- **`agendaIssues`**: `Array` - A list of agenda issues, each with properties like:
- `title`: `string` - The title of the agenda issue.
- `number`: `number` - The issue number.
- `html_url`: `string` - The URL to the issue on GitHub.
- **`agendaLabel`**: `string` - The label used to identify agenda items.
- **`meetingNotes`**: `string` - A link or content for meeting notes.
- **`owner`**: `string` - The GitHub repository owner.
- **`repo`**: `string` - The GitHub repository name.
- **`title`**: `string` - The title of the issue, which can be dynamically generated.
- **`invitees`**: `Array` - A list of invitees, if provided.
- **`observers`**: `Array` - A list of observers, if provided.
```ejs
<% const timezones = [
'America/Los_Angeles',
'America/Denver',
'America/Chicago',
'America/New_York',
'Europe/London',
'Europe/Amsterdam',
'Europe/Moscow',
'Asia/Kolkata',
'Asia/Shanghai',
'Asia/Tokyo',
'Australia/Sydney'
]; %>
## Date/Time
| Timezone | Date/Time |
|----------|-----------|
<%= timezones.map((zone) => {
const zonedDate = date.toZonedDateTimeISO(zone)
const formatter = new Intl.DateTimeFormat('en-US', {
weekday: 'short',
month: 'short',
day: '2-digit',
year: 'numeric',
hour: '2-digit',
minute: '2-digit',
hour12: true,
timeZone: zone
})
const formattedDate = formatter.format(new Date(zonedDate.epochMilliseconds))
return `| ${zone} | ${formattedDate} |`
}).join('\n') %>
Or in your local time:
* https://www.timeanddate.com/worldclock/fixedtime.html?msg=<%= encodeURIComponent(title) %>&iso=<%= date.toZonedDateTimeISO('UTC').toPlainDateTime().toString().slice(0, 16).replace(/[-:]/g, '') %>&p1=1440&ah=1
## Agenda
Extracted from **<%= agendaLabel %>** labelled issues and pull requests from **<%= owner %>/<%= repo %>** prior to the meeting.
<%= agendaIssues.map((i) => {
return `* ${i.html_url}`
}).join('\n') %>
## Links
* Minutes: <%= meetingNotes || '' %>
## Joining the meeting
* link for participants: <%= meetingLink %>
---
Please use the following emoji reactions in this post to indicate your
availability.
* 👍 - Attending
* 👎 - Not attending
* 😕 - Not sure yet
```
### JS API Usage
The main logic of the module is also published to npm.
```sh
$ npm i @pkgjs/meet
```
```javascript
const maker = require('@pkgjs/meet')
;(async () => {
const issue = await maker.meetings.createNextMeeting(client, {
owner: 'pkgjs',
repo: 'meet',
schedules: []
})
console.log(issue) // the response from the GitHub api creating the issue
})()
```
## Contributing
This package welcomes contributions. While the basic unit tests are runnable
(`npm t`) Unfortunatly because it is requires access to the GitHub api it means
you need to have a token with access to create the issues as part of the
integration tests. To specify the key you need to create a personal access token
and put it in a `.env` file as `GITHUB_TOKEN=`. Then you can run
`npm run test:integration` to run the main integration tests. To be honest this
should probably be configurable, contributions welcome.