https://github.com/davidanthoff/julia-pkgbutler
https://github.com/davidanthoff/julia-pkgbutler
Last synced: 10 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/davidanthoff/julia-pkgbutler
- Owner: davidanthoff
- License: mit
- Created: 2019-11-10T01:41:10.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2023-01-09T10:39:29.000Z (over 3 years ago)
- Last Synced: 2025-08-27T02:56:25.754Z (11 months ago)
- Language: JavaScript
- Size: 2.24 MB
- Stars: 7
- Watchers: 2
- Forks: 2
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# julia-pkgbutler
## Overview
The GitHub Action repository for the Julia Package Butler.
The underlying functionality for `julia-pkgbutler` is provided by the [`PkgButlerEngine.jl` Julia package](https://github.com/davidanthoff/PkgButlerEngine.jl).
## Functionality
The Julia Package Butler currently makes the following changes to a package repository:
- The GitHub Action workflow for the Package Butler itself is updated to the latest version.
- If the `Project.toml` doesn't have a version bound for `julia` in the `compat` section, it will add a version bound declaring the package compatible with Julia 1.0.
- It will add GitHub Action workflows for continuous integration. These workflows are automatically configured to only run on Julia versions that are compatible with the `compat` entry for Julia in the `Project.toml` file of the package.
- If a `docs/make.jl` file exists, a GitHub Action workflow that builds and deploys documentation is added to the package.
- If a `docs/Project.toml` file exists, the butler will ensure that the version bound on Documenter.jl is no lower than 0.24 (the first version to support building documentation with GitHub Actions).
- Enable [CompatHelper.jl](https://github.com/bcbi/CompatHelper.jl) for the repository.
- Enable [TagBot](https://github.com/JuliaRegistries/TagBot) for the repository.
When the `bach` template is used, these additional channges are made:
- Travis and Appveyor configuration files are removed.
- Whenever any Julia file on `master` is not properly formatted, a PR with formatting changes is opened (based on https://github.com/julia-vscode/DocumentFormat.jl).
- Any PR has an additional check whether Julia code files are properly formatted.