Skip to content

Commit

Permalink
Merge pull request #769 from lmorg/develop
Browse files Browse the repository at this point in the history
v5.3
  • Loading branch information
lmorg committed Dec 8, 2023
2 parents 4088a63 + fe6bab6 commit c35c0d3
Show file tree
Hide file tree
Showing 68 changed files with 1,654 additions and 952 deletions.
97 changes: 97 additions & 0 deletions .github/workflows/deploy-dev-docs.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,97 @@
name: Deploy Dev Docs

on:
push:
branches:
- develop
- website
paths:
- "**/*.md"
- "**/*.yaml"
- "**/*.tmpl"
- "**/*.ts"
- "**/*.scss"
- "**/*.png"
- "**/*.jpeg"
- "**/*.gif"
- "**/*.svg"

workflow_dispatch:

env:
GO_VERSION: "1.21"

jobs:
Deploy-Docs:
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v3
with:
fetch-depth: 0
# if your docs needs submodules, uncomment the following line
# submodules: true

- name: Setup Go ${{ ENV.GO_VERSION }}
uses: actions/setup-go@v4
with:
go-version: ${{ ENV.GO_VERSION }}

- name: Install Docgen
run: |
go build -v github.com/lmorg/murex/utils/docgen
- name: Build Markdown Docs
env:
DOCGEN_TARGET: vuepress
RUN_NUMBER: ${{ github.run_number }}
COMMITHASHSHORT: ${{ github.run_number }}
run: |
./docgen -panic -warning -config gen/docgen.yaml
mv -v *.md *.svg docs/
mv -v gen/vuepress docs/.vuepress
echo Lower case documents...
for f in $(find docs -type f -regex '.*?/[-_A-Z]+\..*'); do
mv -v "$f" "$(echo $f | tr '[A-Z]' '[a-z]')"
done
- name: Install pnpm
uses: pnpm/action-setup@v2
with:
run_install: true

- name: Setup Node.js
uses: actions/setup-node@v3
with:
node-version: 18
cache: pnpm

- name: Build Docs
env:
NODE_OPTIONS: --max_old_space_size=8192
run: |-
pnpm run docs:build
> docs/.vuepress/dist/.nojekyll
#- name: Download fontawesome
# env:
# FONT_VERSION: "6.5.1"
# FONT_PATH: "gen/vuepress/public"
# # docs/.vuepress/dist
# run: |-
# wget https://use.fontawesome.com/releases/v${FONT_VERSION}/fontawesome-free-${FONT_VERSION}-web.zip -O ${FONT_PATH}/fontawesome.zip
# unzip ${FONT_PATH}/fontawesome.zip -d ${FONT_PATH}
# mv ${FONT_PATH}/fontawesome-free-${FONT_VERSION}-web ${FONT_PATH}/fontawesome
# rm ${FONT_PATH}/fontawesome.zip

- name: Deploy Docs
env:
AWS_ACCESS_KEY_ID: ${{ secrets.S3_ACCESS }}
AWS_SECRET_ACCESS_KEY: ${{ secrets.S3_SECRET }}
AWS_DEFAULT_REGION: eu-west-1
AWS_DEFAULT_OUTPUT: json
run: |
aws s3 sync docs/.vuepress/dist s3://murex.rocks/develop --exclude "*.md" --no-progress
aws cloudfront create-invalidation --distribution-id "${{ secrets.CLOUDFRONT_DISTRIBUTION_ID_DEV }}" --paths "/*"
8 changes: 2 additions & 6 deletions .github/workflows/deploy-docs.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,6 @@ name: Deploy Docs
on:
push:
branches:
- develop
- website
- master
paths:
- "**/*.md"
Expand Down Expand Up @@ -74,15 +72,13 @@ jobs:
run: |-
pnpm run docs:build
> docs/.vuepress/dist/.nojekyll
- name: Deploy Docs
env:
AWS_ACCESS_KEY_ID: ${{ secrets.S3_ACCESS }}
AWS_SECRET_ACCESS_KEY: ${{ secrets.S3_SECRET }}
AWS_DEFAULT_REGION: eu-west-1
AWS_DEFAULT_OUTPUT: json
run: |
aws s3 sync docs/.vuepress/dist s3://murex.rocks/${{ github.ref_name }} --exclude "*.md" --no-progress
aws cloudfront create-invalidation --distribution-id "${{ secrets.CLOUDFRONT_DISTRIBUTION_ID_DEV }}" --paths "/*"
aws cloudfront create-invalidation --distribution-id "${{ secrets.CLOUDFRONT_DISTRIBUTION_ID_WEBSITE }}" --paths "/*"
aws s3 sync docs/.vuepress/dist s3://murex.rocks/master --exclude "*.md" --no-progress
aws cloudfront create-invalidation --distribution-id "${{ secrets.CLOUDFRONT_DISTRIBUTION_ID_MASTER }}" --paths "/*"
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ murex.upx
/docgen.exe
bin/
VERSION
deleteme.db

# WebAssembly
murex.wasm
Expand Down
38 changes: 21 additions & 17 deletions INSTALL.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,14 +4,15 @@

<div id="toc">

- [Pre-Compiled Binaries (HTTPS download)](#pre-compiled-binaries-https-download)
- [Installing From A Package Manager](#installing-from-a-package-manager)
- [ArchLinux](#archlinux)
- [FreeBSD Ports](#freebsd-ports)
- [Homebrew](#homebrew)
- [MacPorts](#macports)
- [Pre-Compiled Binaries (HTTPS download)](#pre-compiled-binaries-https-download)
- [Compiling From Source](#compiling-from-source)
- [Installation From Source Steps](#installation-from-source-steps)
- [Prerequisites](#prerequisites)
- [Compiling](#compiling)
- [External Dependencies (Optional)](#external-dependencies-optional)
- [Recommended Terminal Typeface](#recommended-terminal-typeface)

Expand All @@ -29,16 +30,6 @@ software to provide those utilities.
There is a more detailed breakdown of known compatibility issues in the
[docs/supported platforms](docs/supported-platforms.md) document.

## Pre-Compiled Binaries (HTTPS download)

[![Version](version.svg)](DOWNLOAD.md)
[![Build Murex Downloads](https://github.com/lmorg/murex/actions/workflows/murex-downloads.yaml/badge.svg)](https://github.com/lmorg/murex/actions/workflows/murex-downloads.yaml)

If you wish to download a pre-compiled binary then head to the [DOWNLOAD](DOWNLOAD.md)
page to select your platform.



## Installing From A Package Manager

> This is the recommended way to install Murex because you can then stay
Expand Down Expand Up @@ -73,11 +64,27 @@ brew install murex
sudo port install murex
```

## Pre-Compiled Binaries (HTTPS download)

[![Version](version.svg)](DOWNLOAD.md)
[![Build Murex Downloads](https://github.com/lmorg/murex/actions/workflows/murex-downloads.yaml/badge.svg)](https://github.com/lmorg/murex/actions/workflows/murex-downloads.yaml)

If you wish to download a pre-compiled binary then head to the [DOWNLOAD](DOWNLOAD.md)
page to select your platform.



## Compiling From Source

[![Test Clean Install](https://github.com/lmorg/murex/actions/workflows/clean-build.yaml/badge.svg)](https://github.com/lmorg/murex/actions/workflows/clean-build.yaml)

**Prerequisites:**
> Murex is designed to be as easy to compile as possible. However if you do not
> have any prior experience with compiling software from source then the
> recommended approach for installing Murex is either via a package manager (if
> your platform is already supported) or downloading one of our pre-compiled
> binaries.
### Prerequisites

You will need `go` (Golang) compiler, and `git` installed.

Expand All @@ -92,10 +99,7 @@ package manager first but see further reading below if you get stuck.
* [How to install Go](https://golang.org/doc/install)
* [How to install git](https://github.com/git-guides/install-git)

### Installation From Source Steps

> Compiling from source is not recommended unless you already have a reasonable
> understanding of compiling Go projects for your specific platform.
### Compiling

Installation from source is as simple as the following one liner:

Expand Down
4 changes: 2 additions & 2 deletions app/app.go
Original file line number Diff line number Diff line change
Expand Up @@ -14,8 +14,8 @@ const Name = "murex"
const (
version = "%d.%d.%d"
Major = 5
Minor = 2
Revision = 7610
Minor = 3
Revision = 3000
)

// Copyright is the copyright owner string
Expand Down

0 comments on commit c35c0d3

Please sign in to comment.