Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add update-formula Github action #12

Draft
wants to merge 5 commits into
base: main
Choose a base branch
from
Draft

Add update-formula Github action #12

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
0c95b37
Install GHC from the bindist
paulcadman Jun 15, 2023
ee98e31
Apply fixes from `brew audit`
paulcadman Jun 16, 2023
d4576ef
Add update-formula action
paulcadman Jun 16, 2023
bc29ab5
Make the revision field required
paulcadman Jun 16, 2023
287cf23
Build the bottle and update the formula with sha256
paulcadman Jun 16, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
103 changes: 103 additions & 0 deletions .github/workflows/update-formula.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,103 @@
name: Update formula
on:
workflow_dispatch:
inputs:
version:
description: 'Juvix version (e.g. 0.4.0)'
required: true
revision:
description: 'Juvix release git ref (e.g 925d7cb749711168d9baf6fc176a06330398824e)'
required: true

jobs:
validate-input:
name: "Validate version string"
runs-on: ubuntu-latest
steps:
- name: Validate version
run: |
JUVIX_VERSION="${{ github.event.inputs.version }}"
echo "::debug::version $JUVIX_VERSION"
if [[ ! $JUVIX_VERSION =~ ^[0-9]+(\.[0-9]+){2}$ ]]; then
echo
echo "::error::Bad version input"
exit 1
fi
- name: Validate revision
run: |
JUVIX_REVISION="${{ github.event.inputs.revision }}"
echo "::debug::revision $JUVIX_REVISION"
if [[ ! $JUVIX_REVISION =~ ^[a-f0-9]{40}$ ]]; then
echo
echo "::error::Bad revision input"
exit 1
fi

update-formula:
name: "Make a PR that updates the juvix formula"
needs: validate-input
runs-on: macos-latest
env:
HOMEBREW_NO_AUTO_UPDATE: 1
HOMEBREW_NO_INSTALL_CLEANUP: 1
HOMEBREW_NO_INSTALL_FROM_API: 1
steps:
- name: Setup parameters
run: |
JUVIX_VERSION="${{ github.event.inputs.version }}"
JUVIX_REVISION="${{ github.event.inputs.revision }}"

echo "::debug::version $JUVIX_VERSION"
echo "::debug::revision $JUVIX_REVISION"

echo "JUVIX_VERSION=$JUVIX_VERSION" >> $GITHUB_ENV
echo "JUVIX_REVISION=$JUVIX_REVISION" >> $GITHUB_ENV

- name: Tap formula
run: |
brew tap anoma/juvix
echo "BREW_TAP_DIRECTORY=$(brew --repository anoma/juvix)" >> $GITHUB_ENV

- name: Create branch
working-directory: ${{ env.BREW_TAP_DIRECTORY }}
run: |
BRANCH_NAME="juvix-formula-update-${JUVIX_VERSION}-${RANDOM}"
git checkout -b $BRANCH_NAME
git push -u origin $BRANCH_NAME

- name: Update homebrew formula
working-directory: ${{ env.BREW_TAP_DIRECTORY }}
run: |
brew bump-formula-pr \
--version $JUVIX_VERSION \
--revision $JUVIX_REVISION \
--no-audit \
--write-only \
--commit \
--verbose \
Formula/juvix.rb

- name: Build x86_64 bottle
working-directory: ${{ env.BREW_TAP_DIRECTORY }}
run: |
brew install --build-bottle --verbose --debug Formula/juvix.rb
brew bottle --write --root-url https://github.com/anoma/juvix/releases/download/v$JUVIX_VERSION Formula/juvix.rb

- name: Upload x86_64 bottle
working-directory: ${{ env.BREW_TAP_DIRECTORY }}
uses: actions/upload-artifact@v3
with:
name: juvix-x86-bottle
path: juvix*.tar.gz

- name: Push commit
working-directory: ${{ env.BREW_TAP_DIRECTORY }}
run: |
git push

- name: Open pull request
working-directory: ${{ env.BREW_TAP_DIRECTORY }}
run: |
git pr create \
--title "juvix $JUVIX_VERSION" \
--body "Created by update-formula action"
266 changes: 145 additions & 121 deletions Formula/juvix.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,131 +1,156 @@
# coding: utf-8
class Juvix < Formula
desc "The Juvix compiler"
homepage "https://juvix.org"
desc "Compiler"
homepage "https://juvix.org"
license "AGPL-3.0-or-later"

# This version must match the GHC version used by the stack resolver in the Juvix project
@@ghc_version = "9.2.7"

stable do
url "https://github.com/anoma/juvix.git",
using: :git,
revision: "925d7cb749711168d9baf6fc176a06330398824e"
version "0.4.0"
end

livecheck do
skip "No version information available to check"
end

bottle do
root_url "https://github.com/anoma/juvix/releases/download/v0.4.0"
sha256 cellar: :any_skip_relocation, arm64_ventura: "aeb02413753fdb3a5c427025e44f2eb1ac38510ff7911e99533c42f4a11cc7c4"
sha256 cellar: :any_skip_relocation, ventura: "c0efd50f71d8fcbe7cc410af3fa707dcc4afd19edfa8fcdfd29fa36e6d1a27b6"
end

head do
url "https://github.com/anoma/juvix.git", branch: "main"
license "AGPL-3.0-or-later"

stable do
url "https://github.com/anoma/juvix.git", branch: "main"
version "0.4.0"
sha256 "925d7cb749711168d9baf6fc176a06330398824e"
end

head do
url "https://github.com/anoma/juvix.git", branch: "main"
end
end

livecheck do
skip "No version information available to check"
end

option "without-stack", "Do not install Haskell-Stack"

depends_on "make" => :build
depends_on "llvm" => :build
depends_on "ghcup" => :build

bottle do
root_url "https://github.com/anoma/juvix/releases/download/v0.4.0"
sha256 cellar: :any_skip_relocation, arm64_ventura: "aeb02413753fdb3a5c427025e44f2eb1ac38510ff7911e99533c42f4a11cc7c4"
sha256 cellar: :any_skip_relocation, ventura: "c0efd50f71d8fcbe7cc410af3fa707dcc4afd19edfa8fcdfd29fa36e6d1a27b6"
end
option "without-stack", "Do not install Haskell-Stack"

def install
jobs = ENV.make_jobs
opts = [ "--stack-root", buildpath/".stack" ]
# The runtime build must use the homebrew LLVM installation, not the one provided by macOS.
system "make", "runtime", "CC=#{Formula["llvm"].opt_bin}/clang", "LIBTOOL=#{Formula["llvm"].opt_bin}/llvm-ar"
depends_on "llvm" => :build
depends_on "make" => :build
depends_on "stack" => :build

def system_architecture
require "rbconfig"
RbConfig::CONFIG["host_cpu"]
end

def install
require "tmpdir"
jobs = ENV.make_jobs
opts = ["--stack-root", buildpath/".stack"]
# The runtime build must use the homebrew LLVM installation, not the one provided by macOS.
system "make", "runtime", "CC=#{Formula["llvm"].opt_bin}/clang", "LIBTOOL=#{Formula["llvm"].opt_bin}/llvm-ar"
arch = system_architecture
ghc_basename = "ghc-#{@@ghc_version}-#{arch}-apple-darwin"
ghc_archive_name = "#{ghc_basename}.tar.xz"

ghc_root = Dir.mktmpdir
begin
ENV.prepend_path "PATH", "#{ghc_root}/bin"
with_env(
"LD" => "ld"
"LD" => "ld",
) do
system "ghcup", "install", "stack", "--isolate", buildpath/".ghcup"
system buildpath/".ghcup/stack", "-j#{jobs}", "build" , *opts
system buildpath/".ghcup/stack", "-j#{jobs}", "--local-bin-path=#{bin}", "install" , *opts
# We install GHC using the binary release directly because installation of GHC via ghcup
# or via stack in the formula context is not reliable.
system "curl", "-OL", "https://downloads.haskell.org/~ghc/#{@@ghc_version}/#{ghc_archive_name}"
system "tar", "xf", ghc_archive_name.to_s
Dir.chdir(ghc_basename.to_s) do
system "./configure", "--prefix=#{ghc_root}"
system "make", "install"
end
system "stack", "--system-ghc", "--no-install-ghc", "-j#{jobs}", "--local-bin-path=#{bin}", "install", *opts
end
share.install Dir["juvix-mode/*"]
share.install Dir["examples/*"]
ensure
remove_entry(ghc_root) if ghc_root
end
end

def caveats
<<~EOS
=============================== Juvix examples =================================
To see all the Juvix example files, check out the path:

#{share}/milestone

There, you might want to typecheck a Juvix file. For example, run:

juvix typecheck Fibonacci/Fibonacci.juvix

============================ Juvix mode for Emacs ==============================
To install the Juvix mode in Emacs, please add the following lines to the
configuration file (often at "~/.emacs.d").

(push "#{share}" load-path)
(require 'juvix-mode)

Restart Emacs for the change to take effect. Open Emacs again and the Juvix mode
will be activated automatically for files with extension ".juvix".

To typecheck a Juvix file using the keybinding, press "Ctrl-c + Ctrl-l".

In case you're missing Emacs, we recommend you to install it as follows on MacOS:

brew tap d12frosted/emacs-plus
brew install emacs-plus@28

============================= Juvix VSCode =====================================

You can find the Juvix-Mode plugin in the VSCode marketplace. Alternatively, you
can run the following command on your shell:

ext install heliax.juvix-mode

====================== Install the auto-completion Scripts =====================
To get the Juvix CLI completions for your shell, run the following:

* Bash
juvix --bash-completion-script juvix > ~/.bashrc

* FISH
juvix --fish-completion-script juvix > ~/.config/fish/completions/juvix.fish

* ZSH
juvix --zsh-completion-script juvix > $DIR_IN_FPATH/_juvix

The variable $DIR_IN_FPATH is a directory that is present on the ZSH FPATH
variable (which you can inspect by running `echo $FPATH` in the shell).

Restart your terminal for the settings to take effect.

======================== Compile Juvix programs to Wasm ========================
To compile Juvix to Wasm, please follow the instructions on the website.
The requirement are: wasmer, Clang/LLVM, wasi-sdk, and wasm-ld.

https://docs.juvix.org/latest/howto/installing/

============================ Getting more help =================================
To see all the Juvix commands, run:
juvix --help

To check your setup, run:
juvix doctor

For more documentation, please check out the Juvix Book website:
https://docs.juvix.org

or the Github repository:
https://github.com/anoma/juvix

To see these instructions, run:
brew info juvix
EOS
end
def caveats
<<~EOS
=============================== Juvix examples =================================
To see all the Juvix example files, check out the path:

#{share}/milestone

There, you might want to typecheck a Juvix file. For example, run:

juvix typecheck Fibonacci/Fibonacci.juvix

============================ Juvix mode for Emacs ==============================
To install the Juvix mode in Emacs, please add the following lines to the
configuration file (often at "~/.emacs.d").
#{" "}
(push "#{share}" load-path)
(require 'juvix-mode)
#{" "}
Restart Emacs for the change to take effect. Open Emacs again and the Juvix mode
will be activated automatically for files with extension ".juvix".

To typecheck a Juvix file using the keybinding, press "Ctrl-c + Ctrl-l".

test do
stdlibtest = testpath/"Fibonacci.juvix"
stdlibtest.write <<~EOS
In case you're missing Emacs, we recommend you to install it as follows on MacOS:

brew tap d12frosted/emacs-plus
brew install emacs-plus@28

============================= Juvix VSCode =====================================

You can find the Juvix-Mode plugin in the VSCode marketplace. Alternatively, you
can run the following command on your shell:

ext install heliax.juvix-mode

====================== Install the auto-completion Scripts =====================
To get the Juvix CLI completions for your shell, run the following:

* Bash
juvix --bash-completion-script juvix > ~/.bashrc

* FISH
juvix --fish-completion-script juvix > ~/.config/fish/completions/juvix.fish

* ZSH#{" "}
juvix --zsh-completion-script juvix > $DIR_IN_FPATH/_juvix

The variable $DIR_IN_FPATH is a directory that is present on the ZSH FPATH
variable (which you can inspect by running `echo $FPATH` in the shell).

Restart your terminal for the settings to take effect.

======================== Compile Juvix programs to Wasm ========================#{" "}
To compile Juvix to Wasm, please follow the instructions on the website.
The requirement are: wasmer, Clang/LLVM, wasi-sdk, and wasm-ld.

https://docs.juvix.org/latest/howto/installing/

============================ Getting more help =================================
To see all the Juvix commands, run:
juvix --help

To check your setup, run:
juvix doctor

For more documentation, please check out the Juvix Book website:
https://docs.juvix.org

or the Github repository:
https://github.com/anoma/juvix

To see these instructions, run:
brew info juvix
EOS
end

test do
stdlibtest = testpath/"Fibonacci.juvix"
stdlibtest.write <<~EOS
module Fibonacci;

open import Stdlib.Prelude;
Expand All @@ -140,11 +165,10 @@ module Fibonacci;
main : IO;
main := readLn (printNatLn ∘ fibonacci ∘ stringToNat);

EOS

assert_equal "Well done! It type checks\n", shell_output("#{bin}/juvix typecheck #{stdlibtest}")
# system bin/"juvix", "compile", stdlibtest
# assert_equal "75025" , shell_output("wasmer #{testpath}/Fibonacci.wasm")
end
EOS

assert_equal "Well done! It type checks\n", shell_output("#{bin}/juvix typecheck #{stdlibtest}")
# system bin/"juvix", "compile", stdlibtest
# assert_equal "75025" , shell_output("wasmer #{testpath}/Fibonacci.wasm")
end
end