Added Github Actions; user guide (skeleton).
h3rald h3rald@h3rald.com
Mon, 11 Oct 2021 10:56:13 +0200
3 files changed,
195 insertions(+),
0 deletions(-)
A
.github/workflows/add-artifacts-to-current-release.yml
@@ -0,0 +1,98 @@
+name: Add artifacts to current release + +# Controls when the action will run. +on: + # Allows you to run this workflow manually from the Actions tab + workflow_dispatch: + +jobs: + release: + name: "Build and upload artifacts" + runs-on: ${{ matrix.os }} + strategy: + matrix: + os: + - ubuntu-latest + - macos-latest + - windows-latest + + env: + CHOOSENIM_CHOOSE_VERSION: stable + CHOOSENIM_NO_ANALYTICS: 1 + + steps: + # Cancel other actions of the same type that might be already running + - name: "Cancel similar actions in progress" + uses: styfle/cancel-workflow-action@0.6.0 + with: + access_token: ${{ github.token }} + + # Detects OS and provide Nim-friendly OS identifiers + - name: Detect current OS + id: os + run: echo "::set-output name=id::${{matrix.os == 'ubuntu-latest' && 'linux' || matrix.os == 'macos-latest' && 'macosx' || matrix.os == 'windows-latest' && 'windows'}}" + + # Checks out the repository + - uses: actions/checkout@v2 + + # Installs libraries + - name: install musl-gcc + run: sudo apt-get install -y musl-tools + if: matrix.os == 'ubuntu-latest' + + # Sets path (Linux, macOS) + - name: Update $PATH + run: echo "$HOME/.nimble/bin" >> $GITHUB_PATH + if: matrix.os == 'macos-latest' || matrix.os == 'ubuntu-latest' + + # Sets path (Windows) + - name: Update %PATH% + run: echo "${HOME}/.nimble/bin" | Out-File -FilePath $env:GITHUB_PATH -Encoding utf8 -Append + if: matrix.os == 'windows-latest' + + # Install the Nim compiler + - name: Install Nim + run: | + curl https://nim-lang.org/choosenim/init.sh -sSf > init.sh + sh init.sh -y + + # Build for Linux + - name: Build (Linux) + run: nim c -d:release --gcc.exe:musl-gcc --gcc.linkerexe:musl-gcc --gc:orc --deepcopy:on --opt:size pls + if: matrix.os == 'ubuntu-latest' + + # Build for macOS/Windows + - name: Build (macOS, Windows) + run: nim c -d:release --gc:orc --opt:size pls + if: matrix.os == 'macos-latest' || matrix.os == 'windows-latest' + + # Retrieve ID and Name of the current (draft) release + - name: "Get current release" + id: current-release + uses: InsonusK/get-latest-release@v1.0.1 + with: + myToken: ${{ github.token }} + exclude_types: "release" + view_top: 1 + + # Package the resulting Linux/macOS binary + - name: Create artifact (Linux, macOS) + run: zip pls_${{steps.current-release.outputs.tag_name}}_${{steps.os.outputs.id}}_x64.zip pls + if: matrix.os == 'ubuntu-latest' || matrix.os == 'macos-latest' + + # Package the resulting Windows binary + - name: Create artifact (Windows) + run: Compress-Archive -Path pls.exe -DestinationPath pls_${{steps.current-release.outputs.tag_name}}_windows_x64.zip + if: matrix.os == 'windows-latest' + + # Upload artifacts to current draft release + - name: "Upload to current release" + uses: xresloader/upload-to-github-release@v1 + env: + GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} + with: + file: "pls_v*.zip" + overwrite: true + tag_name: ${{steps.current-release.outputs.tag_name}} + release_id: ${{steps.current-release.outputs.id }} + verbose: true
A
.github/workflows/ci.yml
@@ -0,0 +1,44 @@
+name: CI + +# Controls when the action will run. +on: + # Triggers the workflow on push or pull request events but only for the master branch + push: + branches: [master] + tags-ignore: ["**"] + pull_request: + branches: [master] + tags-ignore: ["**"] + + # Allows you to run this workflow manually from the Actions tab + workflow_dispatch: + +# A workflow run is made up of one or more jobs that can run sequentially or in parallel +jobs: + # This workflow contains a single job called "ci" + ci: + # The type of runner that the job will run on + runs-on: ubuntu-latest + env: + CHOOSENIM_CHOOSE_VERSION: stable + CHOOSENIM_NO_ANALYTICS: 1 + + # Steps represent a sequence of tasks that will be executed as part of the job + steps: + # Checks-out your repository under $GITHUB_WORKSPACE, so your job can access it + - uses: actions/checkout@v2 + + - name: install musl-gcc + run: sudo apt-get install -y musl-tools + + - name: Update $PATH + run: echo "$HOME/.nimble/bin" >> $GITHUB_PATH + + - name: Install Nim + run: | + curl https://nim-lang.org/choosenim/init.sh -sSf > init.sh + sh init.sh -y + + - name: Build + run: | + nimble build -y -d:release --gcc.exe:musl-gcc --gcc.linkerexe:musl-gcc
A
Pls_UserGuide.md
@@ -0,0 +1,53 @@
+% Pls User Guide +% Fabio Cevasco +% - + +## Overview + +### Main features + +#### Manage aliases in a smart way + +#### Define your own aliases for things + +#### Define your own aliases for actions + +#### Execute one or several commands at once + +## Getting started + +### Downloading Pre-built Binaries + +{# release -> [pls for $1]({{release}}/dowload/{{$version}}/pls_v{{$version}}_$2.zip)#} + +The easiest way to get {{n}} is by downloading one of the prebuilt binaries from the [Github Releases Page]({{release -> https://github.com/h3rald/pls/releases}}): + +- {#release||Mac OS X (x64)||macosx_x64#} +- {#release||Windows (x64)||windows_x64#} +- {#release||Linux (x64)||linux_x64#} + +### Building from Source + +You can also build {{n}} from source, if there is no pre-built binary for your platform. + +To do so, after installing the {{nim}} programming language, you can: + +3. Clone the pls [repository](https://github.com/h3rald/pls). +4. Navigate to the [pls](class:dir) repository local folder. +5. Run **nim c -d:release pls.nim** + +## Using pls + +### Managing things + +### Managing actions + +### Executing commands + +### Executing task lists + +## The pls file format + +### things + +### actions