github-workflows-kt
clojure-style-guide
github-workflows-kt | clojure-style-guide | |
---|---|---|
8 | 15 | |
489 | 3,976 | |
1.4% | - | |
9.7 | 2.9 | |
5 days ago | 3 months ago | |
Kotlin | ||
Apache License 2.0 | - |
Stars - the number of stars that a project has on GitHub. Growth - month over month growth in stars.
Activity is a relative number indicating how actively a project is being developed. Recent commits have higher weight than older ones.
For example, an activity of 9.0 indicates that a project is amongst the top 10% of the most actively developed projects that we are tracking.
github-workflows-kt
- GitHub Actions could be so much better
-
XML is better than YAML
We use Kotlin to generate the yaml for our github actions: https://github.com/typesafegithub/github-workflows-kt
Nothing like a good old type safe compiled language to cut down on the verbosity, copy paste usage, silly syntax errors, weird undocumented you just have to know the magical incantations, etc. Kotlin or similar languages are the way to go. Much safer, more compact, easier to cut down on the copy paste reuse (which is just miserable drudgery), easy to introduce some sane abstractions where that makes sense. You get auto completion. And if it compiles, it's likely to just work.
People keep on moving around the deck chairs on the proverbial Titanic when it comes to configuration languages. Substituting yaml for json or toml just moves the problems. And substituting those with XML just introduces other issues and only marginally improves things. Well formed xml is nice. But so is well formed json. Schemas help, if the urls don't 404 and you have tools that can actually do something with them. Which, as it turns out is mostly not a thing in practice. And without that, it's just repetitive bloat. XML with schemas becomes very hard to read quickly.
There's a reason, people started ignoring XML once json became popular: json does most of the essential stuff well enough that XML just isn't worth the effort. And if you have something where you'd actually need the complexity of XML, it's likely to be some really ugly bloated kind of thing where the last thing you'd want to do is edit it manually.
I've dealt with cloudformation in XML form at some point in my life. It sucks. Not just a little bit. It's an absolute piss poor format for a thing like that. Since such a thing was lacking at the time, we ended up actually building our own little tools to generate that xml. Hand editing it was just too painful. One mistake could corrupt your entire stack. And it takes ages to find out if you actually got it right. In Json form it's hardly any better. It's just one of those convoluted over-engineered things. Anyway, Json support for cloudformation was not there at the time and the difference is like asking whether you'd preferred to be shot or stabbed. It's going to suck either way.
-
Typesafe Github Workflows explained to a 5 years old
github-workflows-kt is a tool for creating GitHub Actions workflows in a type-safe script, helping you to build robust workflows for your GitHub projects without mistakes, with pleasure, in Kotlin.
-
Guides for Kotlin scripting use case
The github-workflows-kt project uses Kotlin scripting, and it recommends doing everything using main.kts, because it's easier.
-
Feature Flags in a CI Pipeline
I use matrix tests with github actions to test my kt-search client with different versions of elastisearch and opensearch. Pretty easy to set up: https://github.com/jillesvangurp/kt-search/blob/master/.gith...
Basically it fires up elasticsearch using docker-compose and then the integration tests run against that. You could use a similar strategy to test different feature flag combinations.
For some of our private projects, we use kts to generate the github action yaml files using this: https://github.com/krzema12/github-workflows-kt
Well worth checking out if you have more complex workflows. Yaml is just horrible in terms of copy paste reuse. Also nice to get some compile time safety and auto complete with our action files.
-
Kts Scripting of Yaml & Json Dialects
One of my team members, Nikky, got annoyed with the verbosity and insane amount of copy-paste reuse needed to drive Github Actions. And true to her nature, promptly fixed it by using and contributing to GitHub Actions Kotlin DSL
-
GitHub Actions: a New Hope in YAML Wasteland
GitHub: https://github.com/krzema12/github-actions-kotlin-dsl
- GitHub Actions Kotlin DSL
clojure-style-guide
-
XML is better than YAML
Fixed link to that style guide entry: https://guide.clojure.style/#opt-commas-in-map-literals
Per that style guide, the above map would be formatted like this (on HN, just indent by two spaces):
{:a 1
-
How to be more idiomatic?
As for the broader question of Clojure style, there are style guides like https://github.com/bbatsov/clojure-style-guide and tools like clj-kondo to help learn and reinforce important practices.
-
What makes Clojure better than X for you?
Basically, you learn the expected places to put whitespace, make sure to edit your code accordingly and all of the parens will be automatically closed and adjusted. Using parinfer—which you can also combine with the more traditional paredit—makes writing Clojure code a lot like writing Python.
-
Poignant perspective I found about Clojure's community in r/ExperiencedDevs
Also, there are guidelines, the styleguide, clj-kondo, kibit etc. And if you don't review your interns/juniors code to teach them good practices - you're doing it wrong (well, this one is true for any practical PL out there).
-
How to learn Clojure idioms?
Another good resource is https://guide.clojure.style/ -- the (unofficial) community style guide for Clojure.
-
4-space indents?
It's not an answer to your question but i can refer you to https://github.com/bbatsov/clojure-style-guide
-
Clojure Coding Guide
The same could be said about the "Clojure Style Guide" from the Cider guy. As a matter of fact, there was an issue about it that was quickly declined https://github.com/bbatsov/clojure-style-guide/issues/232
-
Wrote one of my first clojure programs (tic-tac-toe). Any constructive criticism would be greatly appreciated.
Formatting is not that great, see https://github.com/bbatsov/clojure-style-guide btw
- Want to get into closure, but struck at practice
- [clojure-noob][code-review]I've written my first piece of code in clojure, can you guys review it ?
What are some alternatives?
kohttp - Kotlin DSL http client
prettier - Prettier is an opinionated code formatter.
setup-wsl - A GitHub action to install and setup a Linux distribution for the Windows Subsystem for Linux (WSL)
Crafting Interpreters - Repository for the book "Crafting Interpreters"
maven-simple - Example Maven project demonstrating the use of
CppCoreGuidelines - The C++ Core Guidelines are a set of tried-and-true guidelines, rules, and best practices about coding in C++
nix-configs - My Nix{OS} configuration files
30-days-of-elixir - A walk through the Elixir language in 30 exercises.
kotlinpoet - A Kotlin API for generating .kt source files.
Kalman-and-Bayesian-Filters-in-Python - Kalman Filter book using Jupyter Notebook. Focuses on building intuition and experience, not formal proofs. Includes Kalman filters,extended Kalman filters, unscented Kalman filters, particle filters, and more. All exercises include solutions.
github-actions-typing - Bring type-safety to your GitHub actions' API!
papers-we-love - Papers from the computer science community to read and discuss.