https://github.com/rafaeljusto/gddoexp

Library to determinate if a Godoc package should be archived
https://github.com/rafaeljusto/gddoexp

Last synced: 3 months ago
JSON representation

Library to determinate if a Godoc package should be archived

• Host: GitHub
• URL: https://github.com/rafaeljusto/gddoexp
• Owner: rafaeljusto
• License: mit
• Created: 2015-09-26T20:13:22.000Z (over 9 years ago)
• Default Branch: master
• Last Pushed: 2015-10-29T16:42:22.000Z (over 9 years ago)
• Last Synced: 2025-01-17T10:26:43.073Z (5 months ago)
• Language: Go
• Homepage: https://godoc.org/
• Size: 293 KB
• Stars: 0
• Watchers: 2
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# gddoexp

[![GoDoc](https://godoc.org/github.com/rafaeljusto/gddoexp?status.svg)](https://godoc.org/github.com/rafaeljusto/gddoexp) [![Build Status](https://travis-ci.org/rafaeljusto/gddoexp.svg)](https://travis-ci.org/rafaeljusto/gddoexp) [![Coverage Status](https://coveralls.io/repos/rafaeljusto/gddoexp/badge.svg?branch=master&service=github)](https://coveralls.io/github/rafaeljusto/gddoexp?branch=master)

gddoexp (Go Doc Dot Org Expired) was created to indicate if a package from GoDoc

should be suppressed from search results. Idea was born from [issue

320](https://github.com/golang/gddo/issues/320) of [gddo

project](https://github.com/golang/gddo) by [@garyburd](https://github.com/garyburd).

The following rules are current applied to verify if a package should be

suppressed:

* No other packages reference the analyzed package

* Package wasn't modified in the last 2 years

* Package is a fork with a few commits (fast fork)

A fast fork package is a fork created to made some small changes for a pull

request. Currently we tolerate up to 2 commits in a period of 1 week after the

fork date.

## Install

```

go get -u github.com/rafaeljusto/gddoexp/...

```

Remember to add your `$GOPATH/bin` to your `$PATH`.

## Tools

Please check the specific documentation of each tool in the subdirectories.