https://github.com/web-pacotes/github-upsert
Upserts files in a GitHub repo
https://github.com/web-pacotes/github-upsert
github-api npm typescript
Last synced: 3 months ago
JSON representation
Upserts files in a GitHub repo
- Host: GitHub
- URL: https://github.com/web-pacotes/github-upsert
- Owner: web-pacotes
- License: mit
- Created: 2023-04-23T14:47:30.000Z (almost 3 years ago)
- Default Branch: master
- Last Pushed: 2024-02-02T08:28:44.000Z (almost 2 years ago)
- Last Synced: 2025-09-11T09:18:47.092Z (4 months ago)
- Topics: github-api, npm, typescript
- Language: TypeScript
- Homepage: https://web-pacotes.github.io/github-upsert/
- Size: 887 KB
- Stars: 0
- Watchers: 1
- Forks: 1
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# github-upsert
Upserts file into a GitHub repo
  
---
## How to use
To use this package, you will need a Personal Access Token (PAT) with read/write permissions for the repository you want to upload files in. Create one by going to: `Settings > Developer Settings > Personal Access Tokens`.
```typescript
import { default as upsert, GitHubRepository } from 'github-upsert';
// You can grab your personal access token in: Settings > Developer Settings > Personal Access Tokens
const repo = {
name: 'your-github-repo',
owner: 'your-github-username',
pat: 'your-github-pat'
};
const data = new TextEncoder().encode('Hello world!');
const file = { data: data };
const path = 'README.md';
// Upload it
const result = await upsert(repo, file, path);
// Hoooraaaay! It should print the SHA checksum of your file!
console.log(result);
```
Additionally, you can upsert files within the CLI. Execute the following command for more info:
```bash
github-upsert --help
```
## Features
- Uploads/updates a file in a GitHub repository
- Upload/update folder in a GitHub repository (with recursive folder support)
- Agnostic of `io` or file system
- Uses native fetch lib for HTTP requests
## Missing features
- Support for web/lib fetch
---
## Scripts
- `npm run build` to transpile and bundle files in `.cjs`, `.js`, `.d.ts` and respective source-maps
- `npm run start` to run the example project with `swc` compilation
- `npm run test` to run the unit tests
- `npm run lint` to analyze and lint the project
- `npm run format` to format the project based on lint feedback
- `npm run docs` to generate docs site
- `npm run docs:publish` to generate docs site and publish it to GitHub Pages
- `npm run release` to create the temporary changesets file
- `npm run publish` to publish the package to NPM
## Hooks
This repository is configured with client-side Git hooks that automatically format + lint the codebase before each push. You can install it by running the following command:
```bash
./hooks/INSTALL
```
## Automatically Publishing to NPM
To automatically publish the package to NPM, you will need to grab a token of the publisher account for CI usage, and set it as a repository secret in GitHub under the `NPM_TOKEN` identifier.
---
### Bugs and Contributions
Found any bug (including typos) in the package? Do you have any suggestion
or feature to include for future releases? Please create an issue via
GitHub in order to track each contribution. Also, pull requests are very
welcome!