https://github.com/gh-conf/gh-conf-write

Writes to gihub config file
https://github.com/gh-conf/gh-conf-write

config gh-conf gh-conf-write github github-config github-config-write

Last synced: about 2 months ago
JSON representation

Writes to gihub config file

• Host: GitHub
• URL: https://github.com/gh-conf/gh-conf-write
• Owner: gh-conf
• License: mit
• Created: 2019-01-27T17:29:50.000Z (almost 6 years ago)
• Default Branch: master
• Last Pushed: 2024-04-19T23:01:02.000Z (9 months ago)
• Last Synced: 2024-11-25T11:40:02.895Z (2 months ago)
• Topics: config, gh-conf, gh-conf-write, github, github-config, github-config-write
• Language: JavaScript
• Homepage:
• Size: 33.2 KB
• Stars: 100
• Watchers: 8
• Forks: 27
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

        
# gh-conf-write

Write content to github config file

[![Build Status](https://travis-ci.com/gh-conf/gh-conf-write.svg?branch=master)](https://travis-ci.com/gh-conf/gh-conf-write)

[![Github Repo Size](https://img.shields.io/github/repo-size/gh-conf/gh-conf-write.svg)](https://github.com/gh-conf/gh-conf-write)

[![Contributors](https://img.shields.io/github/contributors/gh-conf/gh-conf-write.svg)](https://github.com/gh-conf/gh-conf-write/graphs/contributors)

[![Commit](https://img.shields.io/github/last-commit/gh-conf/gh-conf-write.svg)](https://github.com/gh-conf/gh-conf-write/commits/master)

[![NPM Version](https://img.shields.io/npm/v/@gh-conf/gh-conf-write.svg)](https://www.npmjs.com/package/@gh-conf/gh-conf-write)

It reads the github config file and returns it contents.

It needs respository path as input to read the config.

> Give us a :star: if you like our work :heart:





Please consider donating, if you like my work

## Install

```

$ npm install @gh-conf/gh-conf-write

```

## Usage

```javascript

const { writeConf } = require('@gh-conf/gh-conf-write');

(async () => {

  try {

    const writeResult = await writeConf('./gh-conf-write', 'CONTENT');

    console.log(writeResult);

    /**

     * {

     *   status: 'success',

     *   message: 'Config updated',

     *   data: {

     *       content: 'CONTENT'

     *   }

     * }

     **/

  } catch (error) {

    console.log(error);

  }

})();

```

## Contributing

Interested in contributing to this project?

You can log any issues or suggestion related to this library [here](https://github.com/gh-conf/gh-conf-write/issues/new)

Read our contributing [guide](CONTRIBUTING.md) on getting started with contributing to the codebase

## Contributors