Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
2 changes: 1 addition & 1 deletion .clang-format
Original file line number Diff line number Diff line change
Expand Up @@ -3,5 +3,5 @@ BasedOnStyle: Google
TabWidth: '2'
UseTab: Never
ColumnLimit: 120

AlignConsecutiveAssignments: true
...
7 changes: 5 additions & 2 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,8 @@ bin/microCI
.ccls-cache
dockerfiles/pikchr/pikchr
docs/diagrams/*.png
include/argh.h
include/inicpp.h
# include/argh.h
# include/inicpp.h
include/inja.hpp
include/nlohmann/json.hpp
include/sha1.h
Expand All @@ -18,3 +18,6 @@ test/.env
test/.env.yml
test/failure_test/a.c
.vim-bookmarks
macos/package/usr/local/bin
macos/MicroCI-*.pkg
.DS_Store
12 changes: 12 additions & 0 deletions docs/00_install.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
# Installation

## Linux

To install the latest stable version run:

```bash
sudo curl -fsSL https://github.com/geraldolsribeiro/microci/releases/latest/download/microCI \
-o /usr/bin/microCI
sudo chmod 755 /usr/bin/microCI
```

8 changes: 8 additions & 0 deletions docs/00_uninstall.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
# How to uninstall

Use the following command to remove **microCI** from your system.

```
microCI --uninstall | bash
```

13 changes: 10 additions & 3 deletions docs/00_update.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,14 @@
# Usage
# How to update

Use the following command to download and install the latest version of **microCI**.
Use the following command to download and install the latest stable version of **microCI**.

```
microCI --update | bash
```
```

If you want to update to the latest development version, use this command.

```
microCI --update-dev | bash
```

19 changes: 19 additions & 0 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,6 +47,8 @@ triggered, execute `microCI` in the respective project folders.

## Installation

### Linux

The installation is equally simple, just copy the executable to a folder in the `PATH`.
To remove the `microCI` from the system delete the file copied to the PATH.

Expand All @@ -56,6 +58,23 @@ sudo curl -fsSL https://github.com/geraldolsribeiro/microci/releases/latest/down
sudo chmod 755 /usr/bin/microCI
```

### MacOS

**Warning::** The installation process is not validated yet.

```bash
sudo curl -fsSL https://github.com/geraldolsribeiro/microci/releases/latest/download/microCI-macos-arm64.tar.gz \
-o /usr/bin/microCI
sudo chmod 755 /usr/local/bin/microCI
```

## Windows

Sorry :(

I have no plan for a version running on MS Windows.
Be free to compile and try by yourself.

## Docker Container

You can use **any Docker container** for execution, both public ones from
Expand Down
2 changes: 1 addition & 1 deletion docs/plugin_bash.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ steps:
# Comments are allowed between commands
apt update
apt upgrade -y
# These packages are installed in the image
# Install dependencies inside docker image
apt install -y xxd libspdlog-dev libyaml-cpp-dev
make -C src clean all
make -C test
Expand Down
2 changes: 1 addition & 1 deletion include/MicroCI.hpp
Original file line number Diff line number Diff line change
Expand Up @@ -116,7 +116,7 @@ class MicroCI {
string mDefaultDockerImage;
string mDefaultWorkspace;
stringstream mScript;
bool mIsValid = true;
bool mIsValid = true;
bool mAppendLog = false;

map<string, shared_ptr<microci::PluginStepParser>> mPluginParserMap;
Expand Down
2 changes: 1 addition & 1 deletion include/PluginStepParser.hpp
Original file line number Diff line number Diff line change
Expand Up @@ -72,7 +72,7 @@ class PluginStepParser {
void prepareRunDocker(const json &data, const set<EnvironmentVariable> &envs, const set<DockerVolume> &volumes);

MicroCI *mMicroCI = nullptr;
bool mIsValid = true;
bool mIsValid = true;
};

} // namespace microci
Expand Down
Loading
Loading