https://github.com/egoist/repo-first-commit

Get the first commit of any GitHub repo.
https://github.com/egoist/repo-first-commit

first-commit github

Last synced: 8 months ago
JSON representation

Get the first commit of any GitHub repo.

• Host: GitHub
• URL: https://github.com/egoist/repo-first-commit
• Owner: egoist
• License: mit
• Created: 2017-02-15T12:12:28.000Z (almost 9 years ago)
• Default Branch: master
• Last Pushed: 2022-06-30T20:08:42.000Z (over 3 years ago)
• Last Synced: 2025-04-10T10:50:37.561Z (9 months ago)
• Topics: first-commit, github
• Language: JavaScript
• Homepage:
• Size: 39.1 KB
• Stars: 4
• Watchers: 2
• Forks: 1
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# repo-first-commit

[![NPM version](https://img.shields.io/npm/v/repo-first-commit.svg?style=flat)](https://npmjs.com/package/repo-first-commit) [![NPM downloads](https://img.shields.io/npm/dm/repo-first-commit.svg?style=flat)](https://npmjs.com/package/repo-first-commit) [![Build Status](https://img.shields.io/circleci/project/egoist/repo-first-commit/master.svg?style=flat)](https://circleci.com/gh/egoist/repo-first-commit) [![donate](https://img.shields.io/badge/$-donate-ff69b4.svg?maxAge=2592000&style=flat)](https://github.com/egoist/donate)

## Install

```bash

yarn add repo-first-commit

```

## Usage

```js

const repo = require('repo-first-commit')

repo({

  owner: 'egoist',

  repo: 'vbuild',

  sha: '5.0'

}).then(commit => {

  console.log(commit.commit.message)

  //=> "init"

})

```

## API

### repo(options)

#### options

##### owner

Type: `string`


Required: `true`

GitHub username

##### repo

Type: `string`


Required: `true`

GitHub repo name

##### sha

Type: `string`

SHA or branch to start listing commits from.

##### token

Type: `string`

GitHub API access token.

## Contributing

1. Fork it!

2. Create your feature branch: `git checkout -b my-new-feature`

3. Commit your changes: `git commit -am 'Add some feature'`

4. Push to the branch: `git push origin my-new-feature`

5. Submit a pull request :D

## Author

**repo-first-commit** © [egoist](https://github.com/egoist), Released under the [MIT](./LICENSE) License.


Authored and maintained by egoist with help from contributors ([list](https://github.com/egoist/repo-first-commit/contributors)).

> [egoistian.com](https://egoistian.com) · GitHub [@egoist](https://github.com/egoist) · Twitter [@rem_rin_rin](https://twitter.com/rem_rin_rin)