Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/schroedinger-hat/cog
Csv tO Github issues
https://github.com/schroedinger-hat/cog
automation csv github github-api
Last synced: 2 days ago
JSON representation
Csv tO Github issues
- Host: GitHub
- URL: https://github.com/schroedinger-hat/cog
- Owner: Schroedinger-Hat
- Created: 2024-01-29T17:00:23.000Z (12 months ago)
- Default Branch: main
- Last Pushed: 2024-01-31T08:53:22.000Z (12 months ago)
- Last Synced: 2024-10-24T13:58:38.076Z (3 months ago)
- Topics: automation, csv, github, github-api
- Language: Go
- Homepage:
- Size: 29.3 KB
- Stars: 0
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- Code of conduct: CODE_OF_CONDUCT.md
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
[![Contributors][contributors-shield]][contributors-url]
[![Forks][forks-shield]][forks-url]
[![Stargazers][stars-shield]][stars-url]
[![Issues][issues-shield]][issues-url]
Table of Contents
## About The Project
This is a project that we use to automate issues creation for vote talks of [Open Source Day](osday.dev). We have the call for speakers on sessionize, where we can download a csv file with talk+speaker name and to let the community vote we need all of them into issues.
The name _COG_ is meant to lead back to the fact that this project is nothing more than a cog in a larger mechanism.
### Tech stack
The main language is [GO](https://go.dev/) and the main graphical library is [bubbletea](https://github.com/charmbracelet/bubbletea), nothing more.
## Usage
At the moment the fastest way to run this is to run:
```bash
go mod tidy
export GHTOKEN=
go run main.go -csv -gh-user -gh-repository
```
The csv must have a similar structure of [this template](./template.csv):
```csv
name,description,labels
issue name,issue description,good first issue;bug;question
another issue name,another issue description,question
```
Is very important to split the labels with the separator _;_ otherwise something unexpected might happen.
Last thing, the most important one: you need a [Github Personal Access Token](https://github.com/settings/tokens) no specific scope are needed.
### Particular cases
If you have a description or title with commas or strange character that can conflict with the csv parsing we encourage you to change the csv value separator and run **COG** with the definition of the new comma separator:
```bash
go mod tidy
export GHTOKEN=
go run main.go -csv -csv-comma -gh-user -gh-repository
```
In most of our usage the new comma separator used is `|`, for this particular case the **COG** run will be:
```bash
go mod tidy
export GHTOKEN=
go run main.go -csv template.csv -csv-comma "|" -gh-user test-user -gh-repository test-repository
```
## Contributing
Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are **greatly appreciated**.
If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement".
Don't forget to give the project a star! Thanks again!
## Contact
Schrödinger's Hat Team - [@schroedinger_hat](mailto:[email protected])
Project Link: [https://github.com/schroedinger-Hat/cog](https://github.com/schroedinger-Hat/cog)
[contributors-shield]: https://img.shields.io/github/contributors/schroedinger-Hat/cog.svg?style=for-the-badge
[contributors-url]: https://github.com/schroedinger-Hat/cog/graphs/contributors
[forks-shield]: https://img.shields.io/github/forks/schroedinger-Hat/cog.svg?style=for-the-badge
[forks-url]: https://github.com/schroedinger-Hat/cog/network/members
[stars-shield]: https://img.shields.io/github/stars/schroedinger-Hat/cog?style=for-the-badge
[stars-url]: https://github.com/schroedinger-Hat/cog/stargazers
[issues-shield]: https://img.shields.io/github/issues/schroedinger-Hat/cog.svg?style=for-the-badge
[issues-url]: https://github.com/schroedinger-Hat/cog/issues
