Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/alonsodomin/cron4s
Cross-platform CRON expression parsing for Scala
https://github.com/alonsodomin/cron4s
cron cron-expression-parsing cross-platform functional scala scalajs time
Last synced: 4 days ago
JSON representation
Cross-platform CRON expression parsing for Scala
- Host: GitHub
- URL: https://github.com/alonsodomin/cron4s
- Owner: alonsodomin
- License: apache-2.0
- Created: 2016-07-29T15:01:18.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2024-03-13T13:51:21.000Z (8 months ago)
- Last Synced: 2024-03-13T15:00:33.586Z (8 months ago)
- Topics: cron, cron-expression-parsing, cross-platform, functional, scala, scalajs, time
- Language: Scala
- Homepage: https://alonsodomin.github.io/cron4s
- Size: 6.2 MB
- Stars: 117
- Watchers: 3
- Forks: 24
- Open Issues: 15
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# Cron4s
[](https://gitter.im/alonsodomin/cron4s?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
[](https://travis-ci.org/alonsodomin/cron4s)
[](https://www.scala-js.org)
[](http://www.apache.org/licenses/LICENSE-2.0.txt)
[](https://maven-badges.herokuapp.com/maven-central/com.github.alonsodomin.cron4s/cron4s-core_2.12)
[](https://www.codacy.com/app/alonso-domin/cron4s?utm_source=github.com&utm_medium=referral&utm_content=alonsodomin/cron4s&utm_campaign=Badge_Grade)
[](https://codecov.io/gh/alonsodomin/cron4s)
[](https://mergify.io)
Idiomatic Cron expression parsing in Scala and ScalaJS.
## Documentation
Please, take a look at the [user guide](https://alonsodomin.github.io/cron4s) for instructions on how to use this library. The remaining of this section will be focused on information for other developers.
### Building
`cron4s` is built using [SBT](https://www.scala-sbt.org):
```bash
git clone https://github.com/alonsodomin/cron4s
cd cron4s
sbt test
```
The user documentation is built/generated using [`sbt-microsites`](https://47deg.github.io/sbt-microsites/) and requires [Jekyll](https://jekyllrb.com) to be installed in the local machine. To generate and browse the latest docs from master follow these steps from the project's root folder:
```bash
sbt makeMicrosite
cd docs/target/site
jekyll serve
```
Then make your browser point to and that's all.
### Cross building
`cron4s` is cross-built and published for several versions of Scala. The different set of versions are configured in the [`build.sbt`](https://github.com/alonsodomin/cron4s/blob/master/build.sbt) file in the `crossScalaVersions` setting. We use the [SBT Github Actions](https://github.com/sbt/sbt-github-actions) plugin to generate Github Actions workflows that are in sync with what has been specified in the `build.sbt` file.
Supporting additional Scala versions is a matter of adding a new version to that setting and then make the codebase compile against it whilst preserving backwards compatibility. The easiest way to check that compatibility is triggering a cross build with SBT:
```bash
sbt +test
```
When making changes to the `build.sbt` file, it is highly recommended to run the `sbt githubWorkflowGenerate` command to ensure that the Github Actions workflows are based on the latest updates.
### Repository Automation
There is some sort of automation configured in this repository to ease the management of some _tedious or repetitive_ tasks:
* **Version upgrades**: The [Scala Steward](https://github.com/fthomas/scala-steward) will be producing pull requests with version upgrades of this library dependencies.
* **Auto-merge**: [Mergify](https://mergify.io) is installed in this repo to do auto-merge of pull requests that meet a given criteria. This said criteria can be modified in the [.mergify](https://github.com/alonsodomin/cron4s/blob/master/.mergify.yml) at the project's root folder.
* **CI Release**: A [Github Actions](https://github.com/alonsodomin/cron4s/actions) workflow has been configured, not just to build the project, but also to be able to release to Maven Central with minimal user interaction. Pushing a tag in the repo with the version number will sign and publish such a release in Maven Central, non-tagged commits to `master` will be published as `SNAPSHOT`.
## Related Projects
This is a non-exhaustive list of other open source projects and libraries that use or are somewhat related to Cron4s. If you have a library that depends on Cron4s you could add it [here](https://github.com/alonsodomin/cron4s/edit/master/README.md):
* [fs2-cron](https://github.com/fthomas/fs2-cron): Create pure functional streams that emit elements based on a given cron schedule.
* [pureconfig-cron4s](https://github.com/pureconfig/pureconfig/tree/master/modules/cron4s): Cron expression parsing support in configuration files.
## Code Of Conduct
See the [Code of Conduct](CODE_OF_CONDUCT.md).
## License
Copyright 2017 Antonio Alonso Dominguez
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.