Skip to content

Latest commit

 

History

History
75 lines (56 loc) · 3.33 KB

README.md

File metadata and controls

75 lines (56 loc) · 3.33 KB
Raw

Newsman

License Gem Version

Newsman is a simple script that collects information about a developer's weekly activity on GitHub and creates a human-readable summary of the work done. To create the summary, Newsman asks ChatGPT to handle all the information about a developer's activity, including their pull requests and created issues.

Install

To install newsman from RubyGems.org use the following command:

gem install newsman

The newest version of newsman will be installed on your system.

How to Use

To use newsman, you need to perfom several actions.

Retrieve GITHUB_TOKEN

First of all, you need to retrieve your GitHub token.

Retrieve OPENAI_TOKEN

Then, you need to set up your OpenAI key.

Run the script

To run the newsman script you should pass GITHUB_TOKEN and OPENAI_TOKEN environment variables together with name, username and repository parameters. If you have some problems you can use --help option to get more info about newsman usage:

Usage: newsman [options]
    -n, --name NAME                  Reporter name. Human readable name that will be used in a report
    -u, --username USERNAME          GitHub username. For example, 'volodya-lombrozo'
    -r, --repository REPOSITORIES    Specify which repositories to include in a report. You can specify several repositories using a comma separator, for example: '-r objectionary/jeo-maven-plugin,objectionary/opeo-maven-plugin'
    -p, --position POSITION          Reporter position in a company. Default value is a 'Software Developer'.
    -o, --output OUTPUT              Output type. Newsman prints a report to a stdout by default. You can choose another options like '-o html', '-o txt' or even '-o html'
    -t, --title TITLE                Project Title. Empty by default
    -m, --model MODEL                AI model to use. gpt-3.5-turbo by default

Example

To run newsman use the following command:

newsman --name "Vladimir Lombrozo" --username "volodya-lombrozo" --repository objectionary/jeo-maven-plugin,objectionary/opeo-maven-plugin

Don't forget to set your own values for name, username and repository parameters. Also you can download this repository and run the newsman script directly using the following command:

./bin/newsman --name "Vladimir Lombrozo" --username "volodya-lombrozo" --repository objectionary/jeo-maven-plugin,objectionary/opeo-maven-plugin

How to build a gem from sources

To create a newsman gem from sources first of all you need to build it:

gem build newsman.gemspec

Then, in the folder you might find a newly created gem file, e.g newsman-0.1.0.gem. To use it in any place of your system you need to install it:

gem install newsman-0.1.0.gem

To check that everythis is fine, just run the following command:

newsman --help

And you should see a welcome message from newsman.

Examples

You can find examples of generated reports here