https://github.com/alejandrohdezma/sbt-github

SBT plugin to read several settings from Github
https://github.com/alejandrohdezma/sbt-github

github mdoc sbt-header sbt-plugin scala

Last synced: 3 months ago
JSON representation

SBT plugin to read several settings from Github

• Host: GitHub
• URL: https://github.com/alejandrohdezma/sbt-github
• Owner: alejandrohdezma
• License: apache-2.0
• Created: 2019-10-17T13:54:29.000Z (over 5 years ago)
• Default Branch: main
• Last Pushed: 2024-05-15T05:15:22.000Z (9 months ago)
• Last Synced: 2024-05-21T04:13:46.809Z (9 months ago)
• Topics: github, mdoc, sbt-header, sbt-plugin, scala
• Language: Scala
• Homepage: https://alejandrohdezma.github.io/sbt-github
• Size: 3.52 MB
• Stars: 9
• Watchers: 4
• Forks: 3
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.md
  • Codeowners: .github/CODEOWNERS

Awesome Lists containing this project

README

        
# SBT plugin to read several settings from Github

This plugin enables several settings automatically by downloading them from Github:

- `homepage`: Retrieved from the Github repository's information.

- `developers`: A list containing the repository collaborators.

- `description`: Retrieved from the Github repository.

- `licenses`: Retrieved from the Github repository.

- `contributors`: The list of repository contributors. This list will not include contributors set in `excludedContributors`.

- `collaborators`: The list of repository collaborators who are also `contributors`. This list will always include collaborators set in `extraCollaborators`.

- `releases`: The list of repository releases.

- `startYear`: Extracted from the repository creation date.

- `yearRange`: A year range that goes from `startYear` to the current year.

- `organizationName`: The repository organization name or the owner's name if `populateOrganizationWithOwner` is set to `true`.

- `organizationEmail`: The repository organization email or the owner's email if `populateOrganizationWithOwner` is set to `true`. 

- `organizationHomepage`: The repository organization homepage or the owner's homepage if `populateOrganizationWithOwner` is set to `true`. 

## Installation

Add the following line to your `plugins.sbt` file:

```sbt

addSbtPlugin("com.alejandrohdezma" % "sbt-github" % "0.12.0")

```

> If you use [mdoc](https://scalameta.org/mdoc/) there's also available an [mdoc integration module](https://alejandrohdezma.github.io/sbt-github/docs/sbt-mdoc)

> If you use [sbt-header](https://github.com/sbt/sbt-header) there's also available an [sbt-header integration module](https://alejandrohdezma.github.io/sbt-github/docs/sbt-header)

If you want to know more about all the plugin's features, please head on to [its website](https://alejandrohdezma.github.io/sbt-github/) where you will find much more information.

## Contributors for this project

|  |  |

| :--: | :--: |

| alejandrohdezma | fedefernandez |