Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/arlac77/gitea-repository-provider

Repository provider for gitea
https://github.com/arlac77/gitea-repository-provider

gitea

Last synced: about 1 month ago
JSON representation

Repository provider for gitea

Host: GitHub
URL: https://github.com/arlac77/gitea-repository-provider
Owner: arlac77
License: bsd-2-clause
Created: 2018-07-26T12:54:31.000Z (over 6 years ago)
Default Branch: master
Last Pushed: 2024-11-13T16:34:48.000Z (about 2 months ago)
Last Synced: 2024-11-13T17:32:18.917Z (about 2 months ago)
Topics: gitea
Language: JavaScript
Size: 3.42 MB
Stars: 0
Watchers: 3
Forks: 0
Open Issues: 1
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

        [![npm](https://img.shields.io/npm/v/gitea-repository-provider.svg)](https://www.npmjs.com/package/gitea-repository-provider)

[![License](https://img.shields.io/badge/License-BSD%203--Clause-blue.svg)](https://opensource.org/licenses/BSD-3-Clause)

[![Typed with TypeScript](https://flat.badgen.net/badge/icon/Typed?icon=typescript\&label\&labelColor=blue\&color=555555)](https://typescriptlang.org)

[![bundlejs](https://deno.bundlejs.com/?q=gitea-repository-provider\&badge=detailed)](https://bundlejs.com/?q=gitea-repository-provider)

[![downloads](http://img.shields.io/npm/dm/gitea-repository-provider.svg?style=flat-square)](https://npmjs.org/package/gitea-repository-provider)

[![GitHub Issues](https://img.shields.io/github/issues/arlac77/gitea-repository-provider.svg?style=flat-square)](https://github.com/arlac77/gitea-repository-provider/issues)

[![Build Status](https://img.shields.io/endpoint.svg?url=https%3A%2F%2Factions-badge.atrox.dev%2Farlac77%2Fgitea-repository-provider%2Fbadge\&style=flat)](https://actions-badge.atrox.dev/arlac77/gitea-repository-provider/goto)

[![Styled with prettier](https://img.shields.io/badge/styled_with-prettier-ff69b4.svg)](https://github.com/prettier/prettier)

[![Commitizen friendly](https://img.shields.io/badge/commitizen-friendly-brightgreen.svg)](http://commitizen.github.io/cz-cli/)

[![Known Vulnerabilities](https://snyk.io/test/github/arlac77/gitea-repository-provider/badge.svg)](https://snyk.io/test/github/arlac77/gitea-repository-provider)

[![Coverage Status](https://coveralls.io/repos/arlac77/gitea-repository-provider/badge.svg)](https://coveralls.io/github/arlac77/gitea-repository-provider)

# gitea-repository-provider

repository provider for gitea

# usage

# API

### Table of Contents

*   [GiteaBranch](#giteabranch)

    *   [writeEntry](#writeentry)

        *   [Parameters](#parameters)

    *   [commit](#commit)

        *   [Parameters](#parameters-1)

*   [GiteaContentEntry](#giteacontententry)

    *   [Parameters](#parameters-2)

*   [GiteaMasterOnlyContentEntry](#giteamasteronlycontententry)

    *   [Parameters](#parameters-3)

*   [GiteaOrganization](#giteaorganization)

*   [GiteaProvider](#giteaprovider)

    *   [initializeRepositories](#initializerepositories)

    *   [repositoryBases](#repositorybases)

    *   [name](#name)

    *   [instanceIdentifier](#instanceidentifier)

*   [GiteaPullRequest](#giteapullrequest)

    *   [states](#states)

    *   [list](#list)

        *   [Parameters](#parameters-4)

*   [GiteaRepository](#gitearepository)

    *   [update](#update)

*   [GiteaUser](#giteauser)

## GiteaBranch

**Extends Branch**

### writeEntry

Writes content into the branch.

#### Parameters

*   `entry` **ContentEntry** 

*   `message` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** 

Returns **[Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\** written content with sha values set

### commit

Commit entries.

#### Parameters

*   `message` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** commit message

*   `entries` **[Array](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array)\** content to be commited

*   `options` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)?** 

Returns **[Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\** 

## GiteaContentEntry

**Extends BufferContentEntryMixin(ContentEntry)**

works for all branches

### Parameters

*   `name`  

*   `mode`  

*   `branch`  

## GiteaMasterOnlyContentEntry

**Extends StreamContentEntryMixin(ContentEntry)**

only works for master branch

### Parameters

*   `name`  

*   `mode`  

*   `branch`  

## GiteaOrganization

**Extends RepositoryGroup**

## GiteaProvider

**Extends MultiGroupProvider**

Gitea provider.

Known environment variables:

*   GITEA\_TOKEN api token

*   GITEA\_API api url

### initializeRepositories

*   **See**: 

### repositoryBases

All possible base urls.

Returns **[Array](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array)<[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)>** common base urls of all repositories

### name

We are called gitea.

Returns **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** gitea

### instanceIdentifier

Returns **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** default env name prefix

## GiteaPullRequest

**Extends PullRequest**

### states

possible states

### list

List all pull request for a given repo.

Result will be filtered by source branch, destination branch and states.

#### Parameters

*   `respository` **Repository** 

*   `filter` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)**  (optional, default `{}`)

    *   `filter.source` **Branch?** 

    *   `filter.destination` **Branch?** 

    *   `filter.states` **[Set](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Set)<[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)>?** 

Returns **AsyncIterable\** 

## GiteaRepository

**Extends Repository**

*   **See**: 

### update

## GiteaUser

**Extends RepositoryGroup**

# install

With [npm](http://npmjs.org) do:

```shell

npm install gitea-repository-provider

```

# license

BSD-2-Clause