Skip to content

Commit

Permalink
feat: Initial commit
Browse files Browse the repository at this point in the history
Co-authored-by: kazysgurskas <12516828+kazysgurskas@users.noreply.github.com>
  • Loading branch information
konradasb and kazysgurskas committed Mar 13, 2024
0 parents commit b996018
Show file tree
Hide file tree
Showing 77 changed files with 5,613 additions and 0 deletions.
12 changes: 12 additions & 0 deletions .editorconfig
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
# EditorConfig is awesome: https://EditorConfig.org

# top-most EditorConfig file
root = true

[*]
indent_style = space
indent_size = 2
end_of_line = lf
charset = utf-8
trim_trailing_whitespace = false
insert_final_newline = false
11 changes: 11 additions & 0 deletions .github/dependabot.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
---
version: 2
updates:
- package-ecosystem: "docker"
directory: "/"
schedule:
interval: weekly
- package-ecosystem: "gomod"
directory: "/"
schedule:
interval: weekly
40 changes: 40 additions & 0 deletions .github/workflows/deploy-docs.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
name: deploy-docs

on:
push:
branches:
- main
paths:
- 'docs/**'

permissions:
contents: write

jobs:
deploy:
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v4

- name: Setup Python
uses: actions/setup-python@v4
with:
python-version: 3.x

- name: Set cache ID
run: echo "cache_id=$(date --utc '+%V')" >> $GITHUB_ENV

- name: Save cache
uses: actions/cache@v3
with:
key: mkdocs-material-${{ env.cache_id }}
path: .cache
restore-keys: |
mkdocs-material-
- name: Pip install
run: pip install mkdocs-material

- name: Deploy
run: mkdocs gh-deploy --force
29 changes: 29 additions & 0 deletions .github/workflows/lint.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
---
name: lint

on:
pull_request:

permissions:
pull-requests: read
contents: read
checks: write

jobs:
golangci-lint:
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v4

- name: Setup Go
uses: actions/setup-go@v5
with:
go-version: '1.22.1'

- name: Run golangci-lint
uses: golangci/golangci-lint-action@v4
with:
version: v1.56.2
skip-cache: true
args: --timeout 5m --verbose
22 changes: 22 additions & 0 deletions .github/workflows/release-please.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
---
name: release-please

on:
workflow_dispatch:
push:
branches:
- main

permissions:
pull-requests: write
contents: write
packages: write

jobs:
release-please:
runs-on: ubuntu-latest
steps:
- name: Run release-please
uses: google-github-actions/release-please-action@v4
with:
token: ${{ secrets.ORG_GITHUB_TOKEN }}
34 changes: 34 additions & 0 deletions .github/workflows/release.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
---
name: release

on:
workflow_dispatch:
push:
tags:
- 'v*.*.*'

permissions:
contents: write
packages: write

jobs:
goreleaser:
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v4
with:
fetch-depth: 0

- name: Set up Go
uses: actions/setup-go@v5
with:
go-version: 1.22.1

- name: Run GoReleaser
uses: goreleaser/goreleaser-action@v5
with:
version: latest
args: release --clean
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
21 changes: 21 additions & 0 deletions .github/workflows/test.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
---
name: test

on:
pull_request:

jobs:
test:
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v4

- name: Setup Go
uses: actions/setup-go@v5
with:
go-version: '1.22.1'

- name: Run tests
run: |
go test -v ./...
22 changes: 22 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
# If you prefer the allow list template instead of the deny list, see community template:
# https://github.com/github/gitignore/blob/main/community/Golang/Go.AllowList.gitignore
#
# Binaries for programs and plugins
*.exe
*.exe~
*.dll
*.so
*.dylib

# Test binary, built with `go test -c`
*.test

# Output of the go coverage tool, specifically when used with LiteIDE
*.out

# Dependency directories (remove the comment below to include it)
# vendor/

# Go workspace file
go.work
go.work.sum
61 changes: 61 additions & 0 deletions .goreleaser.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,61 @@
---
project_name: fireactions

builds:
- id: fireactions
main: ./cmd/fireactions
env:
- CGO_ENABLED=0
binary: fireactions
goos:
- linux
goarch:
- amd64
- arm64
ldflags:
- -X github.com/hostinger/fireactions.Version={{ .Version }}
- -X github.com/hostinger/fireactions.Commit={{ .ShortCommit }}
- -X github.com/hostinger/fireactions.Date={{ .CommitDate }}

archives:
- id: fireactions
builds:
- fireactions
name_template: fireactions-{{ .Version }}_{{ .Os }}_{{ .Arch }}
format: tar.gz

dockers:
- id: fireactions-amd64
dockerfile: Dockerfile
image_templates:
- ghcr.io/hostinger/fireactions:{{ .Version }}-amd64
extra_files:
- "./"
build_flag_templates:
- "--pull"
- "--platform=linux/amd64"
goarch: amd64
- id: fireactions-arm64
dockerfile: Dockerfile
image_templates:
- ghcr.io/hostinger/fireactions:{{ .Version }}-arm64
extra_files:
- "./"
build_flag_templates:
- "--pull"
- "--platform=linux/arm64"
goarch: arm64

docker_manifests:
- name_template: ghcr.io/hostinger/fireactions:{{ .Version }}
image_templates:
- ghcr.io/hostinger/fireactions:{{ .Version }}-amd64
- ghcr.io/hostinger/fireactions:{{ .Version }}-arm64
- name_template: ghcr.io/hostinger/fireactions:latest
image_templates:
- ghcr.io/hostinger/fireactions:{{ .Version }}-amd64
- ghcr.io/hostinger/fireactions:{{ .Version }}-arm64

# Changelog is managed by release-please
changelog:
disable: true
3 changes: 3 additions & 0 deletions .release-please-manifest.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
{
".": "0.0.1"
}
1 change: 1 addition & 0 deletions CODEOWNERS
Validating CODEOWNERS rules …
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
* @konradasb
93 changes: 93 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,93 @@
<!-- omit in toc -->
# Contributing to Fireactions

First off, thanks for taking the time to contribute! ❤️

All types of contributions are encouraged and valued. See the [Table of Contents](#table-of-contents) for different ways to help and details about how this project handles them. Please make sure to read the relevant section before making your contribution. It will make it a lot easier for us maintainers and smooth out the experience for all involved. The community looks forward to your contributions. 🎉

> And if you like the project, but just don't have time to contribute, that's fine. There are other easy ways to support the project and show your appreciation, which we would also be very happy about:
>
> - Star the project
> - Tweet about it
> - Mention the project at local meetups and tell your friends/colleagues
> - Refer this project in your project's README
<!-- omit in toc -->
## Table of Contents

- [I Have a Question](#i-have-a-question)
- [I Want To Contribute](#i-want-to-contribute)
- [Reporting Bugs](#reporting-bugs)
- [Suggesting Enhancements](#suggesting-enhancements)

## I Have a Question

> If you want to ask a question, we assume that you have read the available [Documentation](https://fireactions.io).
Before you ask a question, it is best to search for existing [Issues](https://github.com/hostinger/fireactions/issues) that might help you. In case you have found a suitable issue and still need clarification, you can write your question in this issue. It is also advisable to search the internet for answers first.

If you then still feel the need to ask a question and need clarification, we recommend the following:

- Open an [Issue](https://github.com/hostinger/fireactions/issues/new).
- Provide as much context as you can about what you're running into.
- Provide project and platform versions (nodejs, npm, etc), depending on what seems relevant.

We will then take care of the issue as soon as possible.

## I Want To Contribute

> ### Legal Notice
>
> When contributing to this project, you must agree that you have authored 100% of the content, that you have the necessary rights to the content and that the content you contribute may be provided under the project license.
### Reporting Bugs

<!-- omit in toc -->
#### Before Submitting a Bug Report

A good bug report shouldn't leave others needing to chase you up for more information. Therefore, we ask you to investigate carefully, collect information and describe the issue in detail in your report. Please complete the following steps in advance to help us fix any potential bug as fast as possible.

- Make sure that you are using the latest version.
- Determine if your bug is really a bug and not an error on your side e.g. using incompatible environment components/versions (Make sure that you have read the [documentation](https://fireactions.io). If you are looking for support, you might want to check [this section](#i-have-a-question)).
- To see if other users have experienced (and potentially already solved) the same issue you are having, check if there is not already a bug report existing for your bug or error in the [bug tracker](https://github.com/hostinger/fireactionsissues?q=label%3Abug).
- Also make sure to search the internet (including Stack Overflow) to see if users outside of the GitHub community have discussed the issue.
- Collect information about the bug:
- Stack trace (Traceback)
- OS, Platform and Version (Windows, Linux, macOS, x86, ARM)
- Version of the interpreter, compiler, SDK, runtime environment, package manager, depending on what seems relevant.
- Possibly your input and the output
- Can you reliably reproduce the issue? And can you also reproduce it with older versions?

<!-- omit in toc -->
#### How Do I Submit a Good Bug Report?

> You must never report security related issues, vulnerabilities or bugs including sensitive information to the issue tracker, or elsewhere in public. Instead sensitive bugs must be sent by email to <security@hostinger.com>.
We use GitHub issues to track bugs and errors. If you run into an issue with the project:

- Open an [Issue](https://github.com/hostinger/fireactions/issues/new). (Since we can't be sure at this point whether it is a bug or not, we ask you not to talk about a bug yet and not to label the issue.)
- Explain the behavior you would expect and the actual behavior.
- Please provide as much context as possible and describe the *reproduction steps* that someone else can follow to recreate the issue on their own. This usually includes your code. For good bug reports you should isolate the problem and create a reduced test case.
- Provide the information you collected in the previous section.

### Suggesting Enhancements

This section guides you through submitting an enhancement suggestion for Fireactions, **including completely new features and minor improvements to existing functionality**. Following these guidelines will help maintainers and the community to understand your suggestion and find related suggestions.

<!-- omit in toc -->
#### Before Submitting an Enhancement

- Make sure that you are using the latest version.
- Read the [documentation](https://fireactions.io) carefully and find out if the functionality is already covered, maybe by an individual configuration.
- Perform a [search](https://github.com/hostinger/fireactions/issues) to see if the enhancement has already been suggested. If it has, add a comment to the existing issue instead of opening a new one.
- Find out whether your idea fits with the scope and aims of the project. It's up to you to make a strong case to convince the project's developers of the merits of this feature. Keep in mind that we want features that will be useful to the majority of our users and not just a small subset. If you're just targeting a minority of users, consider writing an add-on/plugin library.

<!-- omit in toc -->
#### How Do I Submit a Good Enhancement Suggestion?

Enhancement suggestions are tracked as [GitHub issues](https://github.com/hostinger/fireactions/issues).

- Use a **clear and descriptive title** for the issue to identify the suggestion.
- Provide a **step-by-step description of the suggested enhancement** in as many details as possible.
- **Describe the current behavior** and **explain which behavior you expected to see instead** and why. At this point you can also tell which alternatives do not work for you.
- **Explain why this enhancement would be useful** to most Fireactions users. You may also want to point out the other projects that solved it better and which could serve as inspiration.
19 changes: 19 additions & 0 deletions Dockerfile
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
FROM --platform=$TARGETPLATFORM debian:stable-slim

COPY fireactions /usr/bin/fireactions

RUN apt-get update && apt-get install -y --no-install-recommends \
ca-certificates \
&& apt-get autoremove -y \
&& apt-get clean \
&& rm -rf /var/lib/apt/lists/* /tmp/* /var/tmp/* \
&& groupadd -g 1000 fireactions \
&& useradd -u 1000 -g fireactions -s /bin/sh -m fireactions \
&& chown fireactions:fireactions /usr/bin/fireactions \
&& chmod 755 /usr/bin/fireactions

EXPOSE 8080

COPY entrypoint.sh /usr/bin/entrypoint.sh

ENTRYPOINT ["/usr/bin/entrypoint.sh"]
Loading

0 comments on commit b996018

Please sign in to comment.