ccaddrepo

README

ccaddrepo

Add a repository to CodeClimate and add its report id as a secret to GitHub repository.

Documentation

• See examples of use.
• Read the API docs on go.dev.

Contributing

• Pull request are welcome!
• Open an issue if you find a bug.
• If you want to request a new feature or need help, starts a new discussion.
• Read contribution guidelines.

License

MIT Licensed

© 2021

Documentation

Overview

Package ccaddrepo allows to add a GitHub repository to CodeClimate and setup its report id as a CC_TEST_REPORTER_ID secret in the repository.

This two function works together in order to automate the setup of a GitHub repository.

If you are using this package in GitHub Actions, you can easily publish coverages reports to CodeClimate using e.g. paambaati/codeclimate-action(https://github.com/paambaati/codeclimate-action)

Package ccaddrepo allows to add a GitHub repository to CodeClimate and setup its report id as a CC_TEST_REPORTER_ID secret in the repository.

This two function works together in order to automate the setup of a GitHub repository.

If you are using this package in GitHub Actions, you can easily publish coverages reports to CodeClimate using e.g. paambaati/codeclimate-action(https://github.com/paambaati/codeclimate-action)

Index

• func SetReporterIDSecret(options SecretsOptions) error
• type CodeClimate
  • func (cc CodeClimate) AddRepo(reposlug string) (*RepoInfo, error)
  • func (cc CodeClimate) DeleteRepo(repoid string) error
  • func (cc CodeClimate) GetOwnOrgID(orgname string) (string, error)
  • func (cc CodeClimate) GetRepoID(reposlug string) (string, error)
• type RepoInfo
• type SecretsOptions

Examples

• CodeClimate
• SetReporterIDSecret

Functions

func SetReporterIDSecret

func SetReporterIDSecret(options SecretsOptions) error

SetReporterIDSecret setup a secret on a github repository named CC_TEST_REPORTER_ID containing the specified reporterID. The function uses GitHub API to add the secret, so a ghtoken has to be specified.

Example

package main

import (
	"github.com/parrogo/ccaddrepo"
)

func main() {
	err := ccaddrepo.SetReporterIDSecret(ccaddrepo.SecretsOptions{
		RepoSlug:   "",
		GHToken:    "",
		ReporterID: "",
		BadgeID:    "",
		ID:         "",
	})
	if err != nil {
		panic(err)
	}
}

Types

type CodeClimate

type CodeClimate string

CodeClimate represent an authenticated session on Code Climate.

Example

This example show how to use ccaddrepo.AddOnCodeClimate()

package main

import (
	"fmt"

	"github.com/parrogo/ccaddrepo"
)

func main() {
	cc := ccaddrepo.CodeClimate("token")
	reporterID, err := cc.AddRepo("author/repo")
	if err != nil {
		panic(err)
	}
	fmt.Println(reporterID)

}

func (CodeClimate) AddRepo

func (cc CodeClimate) AddRepo(reposlug string) (*RepoInfo, error)

AddRepo create a repository within an organization and return the reporter ID.

func (CodeClimate) DeleteRepo

func (cc CodeClimate) DeleteRepo(repoid string) error

DeleteRepo remove a repository from CodeClimate

func (CodeClimate) GetOwnOrgID

func (cc CodeClimate) GetOwnOrgID(orgname string) (string, error)

GetOwnOrgID returns the ID of an organization

func (CodeClimate) GetRepoID

func (cc CodeClimate) GetRepoID(reposlug string) (string, error)

GetRepoID returns the ID of a repository

type RepoInfo

type RepoInfo struct {
	Data struct {
		ID         string
		Attributes struct {
			TestReporterID string `json:"test_reporter_id"`
			BadgeTokenID   string `json:"badge_token"`
		}
	}
}

RepoInfo represents the information retrieved from a repo

type SecretsOptions

type SecretsOptions struct {
	RepoSlug   string
	GHToken    string
	ReporterID string
	BadgeID    string
	ID         string
}

SecretsOptions contains all the options to setup Code Climate related secrets in a GH repo.