mirror of
https://github.com/erlang-punch/nostr
synced 2026-05-01 09:08:47 +00:00
0fb83a4e52
This commit is a huge one. It had a lot of feature and design the whole project. Documentation, tests, notes, articles, introduction page and main codes have been added. All required dependencies have been added, thoas, gun, and cowboy. Those versions have been fixed. The current client implementation can use a websocket to fetch the event from a relay, the connection can also be closed. Some functions and modules have been created to permit to encode and decode payloads from/to a relay/client. This is not correctly done, yet. A part of nip/01 is already implemented but requires a better structure, better testing and better documentation as well. The parameters for rebar3 and the tools like compilers have been created to ensure a good quality for the produced code. A Makefile can be used to export the notes/articles in pdf, epub, plaintext or html formats.
46 lines
1.3 KiB
Markdown
46 lines
1.3 KiB
Markdown
---
|
|
title: Create Github Actions Workflow
|
|
author: Mathieu Kerjouan
|
|
keywords: github,actions,vagrant,qubeos,erlang
|
|
license: CC BY-NC-ND
|
|
---
|
|
|
|
This documentation is currently a draft and will be updated later when
|
|
the whole pipeline will be correctly used.
|
|
|
|
# Create Github Actions Workflow
|
|
|
|
This documentation was created using QubeOS as main OS. The Github
|
|
Actions runner was executed in a dedicated virtual machine connected
|
|
to Github with Tor.
|
|
|
|
## Test Pipeline Design and Requirement
|
|
|
|
The goal is to test nostr on latest stable Erlang version. At this
|
|
time, the application should be able to be executed on Erlang R25 and
|
|
Erlang R23. Here the rules:
|
|
|
|
- `eunit` MUST be executed with `rebar3`
|
|
- `common_test` MUST be executed with `rebar3`
|
|
- `dialyzer` MAY be executed with `rebar3`
|
|
- profilers MAY be executed with `rebar3`
|
|
|
|
## Github Actions Repository Bootstrapping
|
|
|
|
## Github Actions and QubeOS Disposable VM
|
|
|
|
QubeOS can be used to create short-living virtual machines called
|
|
Disposable VM. These VMs were designed to be executed one-time and all
|
|
the content...
|
|
|
|
## Github Actions and asdf
|
|
|
|
TODO
|
|
|
|
## Github Actions and Containers (docker)
|
|
|
|
Unfortunately, containers are the fatest way to have something working
|
|
in our modern world. Lot of modifications have been needed to maintain
|
|
other version...
|
|
|