Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/alejandrohdezma/sbt-ci
This plugin generates default GitHub Actions workflows, documentation templates and configuration files for @alejandrohdezma's Scala libraries repositories.
https://github.com/alejandrohdezma/sbt-ci
github-actions mdoc scala
Last synced: about 2 months ago
JSON representation
This plugin generates default GitHub Actions workflows, documentation templates and configuration files for @alejandrohdezma's Scala libraries repositories.
- Host: GitHub
- URL: https://github.com/alejandrohdezma/sbt-ci
- Owner: alejandrohdezma
- License: apache-2.0
- Created: 2020-01-28T07:36:02.000Z (almost 5 years ago)
- Default Branch: main
- Last Pushed: 2024-05-15T05:18:42.000Z (8 months ago)
- Last Synced: 2024-05-21T04:13:46.782Z (8 months ago)
- Topics: github-actions, mdoc, scala
- Language: Scala
- Homepage:
- Size: 726 KB
- Stars: 4
- Watchers: 3
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
This plugin generates default GitHub Actions workflows, documentation templates and configuration files for @alejandrohdezma's Scala libraries repositories.
## Installation
Add the following line to your `plugins.sbt` file:
```sbt
addSbtPlugin("com.alejandrohdezma" % "sbt-ci" % "2.16.0")
```
## Usage
Once the plugin has been installed just execute `sbt generateCiFiles` to
automatically add all the documentation, workflows and settings files to the
project. You just need to ensure the `sbt generateCiFiles` is executed when
this plugin gets updated in your repository to bring in new changes. If you use
[Scala Steward](https://github.com/scala-steward-org/scala-steward)
to keep your repositories up-to-date it is super easy. Just add the following
lines to the `.scala-steward.conf` in the root of your repositories:
```conf
postUpdateHooks = [
{
command = ["sbt", "generateCiFiles"],
commitMessage = "Run `sbt generateCiFiles`",
groupId = "com.alejandrohdezma",
artifactId = "sbt-ci"
}
]
```
The library also enables a `DocumentationPlugin` on any project enabling the
`MdocPlugin`. This plugin adds a bunch of default settings for projects using
[mdoc](https://scalameta.org/mdoc/). Specifically it sets so documentation
templates are read from `.github/docs` and written to the root directory.
### Excluding files
You can exclude certain files by using the `excludedFiles` setting:
```sbt
ThisBuild / excludedFiles += "**/*.md"
```
## What files does it generate?
### :octocat: [.github/docs/LICENSE.md](https://github.com/alejandrohdezma/sbt-ci/blob/main/.github/docs/LICENSE.md) (copied as .github/docs/LICENSE.md)
### :octocat: [.github/release.yml](https://github.com/alejandrohdezma/sbt-ci/blob/main/.github/release.yml) (copied as .github/release.yml)
This file contains the template for the "auto-generated release notes"
### :octocat: [.github/workflows/ci.yml](https://github.com/alejandrohdezma/sbt-ci/blob/main/.github/workflows/ci.yml) (copied as .github/workflows/ci.yml)
Runs `sbt ci-test` on the project on differnt JDKs (this task should be added to the project as a command alias
containing the necessary steps to compile, check formatters, launch tests...).
Examples of this `ci-test` alias can be found [here](https://github.com/search?q=org%3Aalejandrohdezma+%22ci-test%22+path%3Abuild.sbt++NOT+is%3Aarchived&type=code).
It will also do the following:
- It will automatically label PRs based on head branch.
- It will automatically enable auto-merge on `Scala Steward` PRs. You'll need to add a `STEWARD_BOT` repository or
organization variable with the name of your scala-steward bot. See https://docs.github.com/en/actions/learn-github-actions/variables.
### :octocat: [.github/workflows/release.yml](https://github.com/alejandrohdezma/sbt-ci/blob/main/.github/workflows/release.yml) (copied as .github/workflows/release.yml)
This workflow performs two tasks:
- Creates a release of the project by running `sbt ci-publish` (this task should be added to the project as a command
alias containing the necessary steps to do a release). Examples of this `ci-publish` alias can be found
[here](https://github.com/search?q=org%3Aalejandrohdezma+%22ci-publish%22+path%3Abuild.sbt++NOT+is%3Aarchived&type=code).
- Runs `sbt ci-docs` on the project and pushes a commit with the changes (the `ci-docs` task should be added to the
project as a command alias containing the necessary steps to update documentation: re-generate docs files,
publish websites, update headers...). Examples of this `ci-docs` alias can be found
[here](https://github.com/search?q=org%3Aalejandrohdezma+%22ci-docs%22+path%3Abuild.sbt++NOT+is%3Aarchived&type=code).
This workflow will launch on pushed tags. Alternatively one can launch it manually using a "workflow dispatch" to
create a snapshot release (this won't trigger the documentation update).
### :octocat: [.gitignore](https://github.com/alejandrohdezma/sbt-ci/blob/main/.gitignore) (copied as .gitignore)
Default .gitignore for the project.
## Using this project as a template
This project is prepared to be used as a template. For a minimum set of changes you just need to:
- Update the list of resources to propagate in `build.sbt` (check for `resourcesToPropagate` setting).
- Change the `organization` setting to your own in `build.sbt`.
- Release the new plugin to Sonatype or another kind of Maven repository.
`README.md` should be auto-updated with the list of new resources once you execute `sbt ci-docs`. You can add some descriptions (as comments at the top of the file) to the propagated resources that will then be added to this file. See [sbt-propagate docs](https://github.com/alejandrohdezma/sbt-propagate) for more information about what can be done.
## Contributors to this project
| 
| 
|
| :--: | :--: |
| alejandrohdezma | juanpedromoreno |