blocklist import/export
Nobody has claimed this yet.
- Dominant language
- JavaScript
- Stars
- 202
- Forks
- 183
- Avg merge
- 2m
- Merged PRs (30d)
- 1
Description
per the recent discussion around the moderation team and importing/exporting the blocklist across our three orgs (nodejs, pkgjs, and nodejs-private), I went ahead and built out a GitHub Action that allows us to import blocklists from one organization to another organization. In practice, this means that if someone is blocked in the nodejs org, that block can be imported to the other organizations automatically (presumably on a cron or manual run of the Action, rather than being directly triggered by the block event).
You can find the code in cutenode/action-import-blocklist. Implementing it requires a PAT from an account (presumably, in our case, the Node.js bot account) that has the full admin:org permissions, which is required by the GitHub API.
@nodejs/tsc @nodejs/actions want to get feedback on this. My proposal:
- implement syncing to
pkgjsandnodejs-privateby setting up.githubrepositories in both and adding workflows. I'm happy to help with this, but it's pretty trivial. - alternatively, implement syncing by setting up a
.githubrepo in thenodejsorg, allowing us to have control within the project of where our blocklist is being exported to and not providingadmin:orgtokens to those orgs (pkgjs is notably more permissive).
questions I have:
- currently, the Action uses
console.log()to output what's happening. This does include usernames. Is this okay, or would we want to omit those? - I'd prefer to move the action to a project-owned organization. Does this belong under
nodejsor underpkgjs?
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by reviewing cutenode/action-import-blocklist and the proposed .github repositories and workflows for pkgjs, nodejs-private, or nodejs. Resolve the ownership, PAT admin:org, scheduling, and username-logging questions before implementing. Done means blocklists sync between the three organizations through an agreed project-owned workflow.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- github-actions, javascript
- Domain
- ci-cd, devops
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100