cutenode / cutenode/nodekitten

GitHub Action

Open
#2 1 comment 1 reaction 0 assignees View on GitHub
Dominant language
JavaScript
Stars
5
Forks
2
PR merge metrics
No merged PRs in 30d

Description

👋 @bnb

thanks for the call 👍🏼

Here is my understanding of what this repository does

1. Loads https://nodejs.org/dist/index.json on a schedule
2. Checks if there is a change
3. If there is a change, send a tweet

Here is what I'd suggest we do

1. Rewrite the current implementation using GitHub Actions
2. Register a @nodekitten GitHub App and implement it using another GitHub Action in this repository
3. Create at least one example GitHub Action that acts on the repository dispatch event.

### Rewrite the current implementation using GitHub Actions

We can create the GitHub Action and make it work in parallel with the current implementation, then once we are happy with it, we can delete all the Azure Functions code.

To start, we should maybe create a twitter account for testing, or use an existing one if you have that. We will have to configure the credentials in this repository's secrets

The Action would load the new JSON file, then write it to this repository, so we don't need an external way of caching it. After loading the JSON, we compare it to the existing one, and if they are the same length then we are done.

@bnb can you take care of setting the secrets? https://github.com/cutenode/nodekitten-serverless/settings/secrets

### Register a @nodekitten GitHub App and implement it using another GitHub Action in this repository

I would start out with creating a README explaining how users can install the `@nodekitten` app and how they can utilize to trigger their own actions

The actual implementation of creating the repository dispatch events will work very similar to what I did for the [octokit-routes app](https://github.com/apps/octokit-routes). Here is the [code](https://github.com/octokit/routes/blob/6ff06247d7c19cf87d04a4b7e5080c0fe0effb18/bin/notify-users.js), it is loaded by [this workflow](https://github.com/octokit/routes/blob/6ff06247d7c19cf87d04a4b7e5080c0fe0effb18/.github/workflows/notify-users.yml)

@bnb Can you take care of registering the @nodekitten app. You can register the app for the @cutenode organization in https://github.com/organizations/cutenode/settings/apps/new. We need the `Contents` permission (read & write). Disable the webhooks. We can update the description later

### Create at least one example GitHub Action that acts on the repository dispatch event

This would be the actual submission to the hackathon. For example, we could write an action that updates the test matrix in GitHub Action workflow files, such as this one: https://github.com/octokit/core.js/blob/ed8ce5c7fa86bb2b60821ba9809c80a7fc0fb712/.github/workflows/test.yml#L15-L18. We could make a set of actions in order to update the config files for the most popular CI services

---

Question: do we also get a trigger when an existing Node release

- becomes LTS?
- becomes maintenance?
- gets out of maintenance?

Contributor guide

No contributing guide indexed for this repository

Research direction

Start by reading the referenced bin/notify-users.js and .github/workflows/notify-users.yml examples, then inspect this repository's existing Azure Functions implementation. The issue describes three coordinated deliverables: scheduled release checking, a @nodekitten GitHub App workflow, and an example repository_dispatch action. Done would require agreed scope, configured secrets and app permissions, working workflows, and documentation including the LTS and maintenance-event behavior.

Written by the indexing model from the issue text.

Assessment

Tech stack
azure, github-actions, javascript, nodejs
Domain
ci-cd, cloud, devops
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
20/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.