-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Loading status checks…
Merge pull request #1 from essentialkaos/develop
Version 0.0.1
Showing
27 changed files
with
1,506 additions
and
2 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,39 @@ | ||
version: "2" | ||
|
||
checks: | ||
argument-count: | ||
enabled: true | ||
config: | ||
threshold: 6 | ||
complex-logic: | ||
enabled: true | ||
config: | ||
threshold: 6 | ||
file-lines: | ||
enabled: true | ||
config: | ||
threshold: 1000 | ||
method-complexity: | ||
enabled: true | ||
config: | ||
threshold: 8 | ||
method-count: | ||
enabled: true | ||
config: | ||
threshold: 20 | ||
method-lines: | ||
enabled: true | ||
config: | ||
threshold: 100 | ||
nested-control-flow: | ||
enabled: true | ||
config: | ||
threshold: 6 | ||
return-statements: | ||
enabled: true | ||
config: | ||
threshold: 6 | ||
similar-code: | ||
enabled: false | ||
identical-code: | ||
enabled: false |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,42 @@ | ||
# Contributor Code of Conduct | ||
|
||
As contributors and maintainers of this project, and in the interest of | ||
fostering an open and welcoming community, we pledge to respect all people who | ||
contribute through reporting issues, posting feature requests, updating | ||
documentation, submitting pull requests or patches, and other activities. | ||
|
||
We are committed to making participation in this project a harassment-free | ||
experience for everyone, regardless of level of experience, gender, gender | ||
identity and expression, sexual orientation, disability, personal appearance, | ||
body size, race, ethnicity, age, religion, or nationality. | ||
|
||
Examples of unacceptable behavior by participants include: | ||
|
||
* The use of sexualized language or imagery | ||
* Personal attacks | ||
* Trolling or insulting/derogatory comments | ||
* Public or private harassment | ||
* Publishing other's private information, such as physical or electronic | ||
addresses, without explicit permission | ||
* Other unethical or unprofessional conduct | ||
|
||
Project maintainers have the right and responsibility to remove, edit, or | ||
reject comments, commits, code, wiki edits, issues, and other contributions | ||
that are not aligned to this Code of Conduct, or to ban temporarily or | ||
permanently any contributor for other behaviors that they deem inappropriate, | ||
threatening, offensive, or harmful. | ||
|
||
By adopting this Code of Conduct, project maintainers commit themselves to | ||
fairly and consistently applying these principles to every aspect of managing | ||
this project. Project maintainers who do not follow or enforce the Code of | ||
Conduct may be permanently removed from the project team. | ||
|
||
This Code of Conduct applies both within project spaces and in public spaces | ||
when an individual is representing the project or its community. | ||
|
||
Instances of abusive, harassing, or otherwise unacceptable behavior may be | ||
reported by contacting a project maintainer at `[email protected]`. All | ||
complaints will be reviewed and investigated and will result in a response that | ||
is deemed necessary and appropriate to the circumstances. Maintainers are | ||
obligated to maintain confidentiality with regard to the reporter of an | ||
incident. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,19 @@ | ||
# Contributing Guidelines | ||
|
||
**IMPORTANT! Contribute your code only if you have an excellent understanding of project idea and all existing code base. Otherwise, a nicely formatted issue will be more helpful to us.** | ||
|
||
### Issues | ||
|
||
1. Provide product version where the problem was found; | ||
2. Provide info about your environment; | ||
3. Provide detailed info about your problem; | ||
4. Provide steps to reproduce the problem; | ||
5. Provide actual and expected results. | ||
|
||
### Code | ||
|
||
1. Check your code **before** creating pull request; | ||
2. If tests are present in a project, add tests for your code; | ||
3. Add inline documentation for your code; | ||
4. Apply code style used throughout the project; | ||
5. Create your pull request to `develop` branch (_pull requests to other branches are not allowed_). |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,64 @@ | ||
name: ❗ Bug Report | ||
description: File a bug report | ||
title: "[Bug]: " | ||
labels: ["issue • bug"] | ||
assignees: | ||
- andyone | ||
|
||
body: | ||
- type: markdown | ||
attributes: | ||
value: | | ||
> [!IMPORTANT] | ||
> Before you open an issue, search GitHub Issues for a similar bug reports. If so, please add a 👍 reaction to the existing issue. | ||
- type: textarea | ||
attributes: | ||
label: Verbose application info | ||
description: Output of `swap-reaper -vv` command | ||
render: shell | ||
validations: | ||
required: true | ||
|
||
- type: dropdown | ||
id: version | ||
attributes: | ||
label: Install tools | ||
description: How did you install this application | ||
options: | ||
- From Sources | ||
- RPM Package | ||
- Prebuilt Binary | ||
default: 0 | ||
validations: | ||
required: true | ||
|
||
- type: textarea | ||
attributes: | ||
label: Steps to reproduce | ||
description: Short guide on how to reproduce this problem on our site | ||
placeholder: | | ||
1. [First Step] | ||
2. [Second Step] | ||
3. [and so on...] | ||
validations: | ||
required: true | ||
|
||
- type: textarea | ||
attributes: | ||
label: Expected behavior | ||
description: What you expected to happen | ||
validations: | ||
required: true | ||
|
||
- type: textarea | ||
attributes: | ||
label: Actual behavior | ||
description: What actually happened | ||
validations: | ||
required: true | ||
|
||
- type: textarea | ||
attributes: | ||
label: Additional info | ||
description: Include gist of relevant config, logs, etc. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
blank_issues_enabled: false |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,26 @@ | ||
name: ❓ Question | ||
description: Question about application, configuration or code | ||
title: "[Question]: " | ||
labels: ["issue • question"] | ||
assignees: | ||
- andyone | ||
|
||
body: | ||
- type: markdown | ||
attributes: | ||
value: | | ||
> [!IMPORTANT] | ||
> Before you open an issue, search GitHub Issues for a similar question. If so, please add a 👍 reaction to the existing issue. | ||
- type: textarea | ||
attributes: | ||
label: Question | ||
description: Detailed question | ||
validations: | ||
required: true | ||
|
||
- type: textarea | ||
attributes: | ||
label: Related version application info | ||
description: Output of `swap-reaper -vv` command | ||
render: shell |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,43 @@ | ||
name: ➕ Suggestion | ||
description: Suggest new feature or improvement | ||
title: "[Suggestion]: " | ||
labels: ["issue • suggestion"] | ||
assignees: | ||
- andyone | ||
|
||
body: | ||
- type: markdown | ||
attributes: | ||
value: | | ||
> [!IMPORTANT] | ||
> Before you open an issue, search GitHub Issues for a similar feature requests. If so, please add a 👍 reaction to the existing issue. | ||
> | ||
> Opening a feature request kicks off a discussion. Requests may be closed if we're not actively planning to work on them. | ||
- type: textarea | ||
attributes: | ||
label: Proposal | ||
description: Description of the feature | ||
validations: | ||
required: true | ||
|
||
- type: textarea | ||
attributes: | ||
label: Current behavior | ||
description: What currently happens | ||
validations: | ||
required: true | ||
|
||
- type: textarea | ||
attributes: | ||
label: Desired behavior | ||
description: What you would like to happen | ||
validations: | ||
required: true | ||
|
||
- type: textarea | ||
attributes: | ||
label: Use case | ||
description: Why is this important (helps with prioritizing requests) | ||
validations: | ||
required: true |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,24 @@ | ||
### What did you implement: | ||
|
||
Closes #XXXXX | ||
|
||
### How did you implement it: | ||
|
||
... | ||
|
||
### How can we verify it: | ||
|
||
... | ||
|
||
### TODO's: | ||
|
||
- [ ] Write tests | ||
- [ ] Write documentation | ||
- [ ] Check that there aren't other open pull requests for the same issue/feature | ||
- [ ] Format your source code by `make fmt` | ||
- [ ] Provide verification config / commands | ||
- [ ] Enable "Allow edits from maintainers" for this PR | ||
- [ ] Update the messages below | ||
|
||
**Is this ready for review?:** No | ||
**Is it a breaking change?:** No |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,36 @@ | ||
version: 2 | ||
|
||
updates: | ||
- package-ecosystem: "gomod" | ||
directory: "/" | ||
target-branch: "develop" | ||
schedule: | ||
interval: "daily" | ||
timezone: "Etc/UTC" | ||
time: "03:00" | ||
labels: | ||
- "PR • MAINTENANCE" | ||
assignees: | ||
- "andyone" | ||
reviewers: | ||
- "andyone" | ||
groups: | ||
all: | ||
applies-to: version-updates | ||
update-types: | ||
- "minor" | ||
- "patch" | ||
|
||
- package-ecosystem: "github-actions" | ||
directory: "/" | ||
target-branch: "develop" | ||
schedule: | ||
interval: "daily" | ||
timezone: "Etc/UTC" | ||
time: "03:00" | ||
labels: | ||
- "PR • MAINTENANCE" | ||
assignees: | ||
- "andyone" | ||
reviewers: | ||
- "andyone" |
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,105 @@ | ||
name: CI | ||
|
||
on: | ||
push: | ||
branches: [master, develop] | ||
pull_request: | ||
branches: [master] | ||
workflow_dispatch: | ||
inputs: | ||
force_run: | ||
description: 'Force workflow run' | ||
required: true | ||
type: choice | ||
options: [yes, no] | ||
|
||
permissions: | ||
actions: read | ||
contents: read | ||
statuses: write | ||
|
||
concurrency: | ||
group: ${{ github.workflow }}-${{ github.ref }} | ||
cancel-in-progress: true | ||
|
||
jobs: | ||
Go: | ||
name: Go | ||
runs-on: ubuntu-latest | ||
|
||
strategy: | ||
matrix: | ||
go: [ '1.22.x', '1.23.x' ] | ||
|
||
steps: | ||
- name: Checkout | ||
uses: actions/checkout@v4 | ||
|
||
- name: Set up Go | ||
uses: actions/setup-go@v5 | ||
with: | ||
go-version: ${{ matrix.go }} | ||
|
||
- name: Download dependencies | ||
run: make deps | ||
|
||
- name: Run tests | ||
run: make all | ||
|
||
Aligo: | ||
name: Aligo | ||
runs-on: ubuntu-latest | ||
|
||
needs: Go | ||
|
||
steps: | ||
- name: Checkout | ||
uses: actions/checkout@v4 | ||
|
||
- name: Set up Go | ||
uses: actions/setup-go@v5 | ||
with: | ||
go-version: '1.22.x' | ||
|
||
- name: Download dependencies | ||
run: make deps | ||
|
||
- name: Check Golang sources with Aligo | ||
uses: essentialkaos/aligo-action@v2 | ||
with: | ||
files: ./... | ||
|
||
Perfecto: | ||
name: Perfecto | ||
runs-on: ubuntu-latest | ||
|
||
needs: Go | ||
|
||
steps: | ||
- name: Code checkout | ||
uses: actions/checkout@v4 | ||
|
||
- name: Login to GitHub Container Registry | ||
uses: docker/login-action@v3 | ||
with: | ||
registry: ghcr.io | ||
username: ${{ github.actor }} | ||
password: ${{ secrets.GITHUB_TOKEN }} | ||
|
||
- name: Check specs with Perfecto | ||
uses: essentialkaos/perfecto-action@v2 | ||
with: | ||
files: common/swap-reaper.spec | ||
|
||
Typos: | ||
name: Typos | ||
runs-on: ubuntu-latest | ||
|
||
needs: Go | ||
|
||
steps: | ||
- name: Checkout | ||
uses: actions/checkout@v4 | ||
|
||
- name: Check spelling | ||
uses: crate-ci/typos@master |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,33 @@ | ||
name: "CodeQL" | ||
|
||
on: | ||
push: | ||
branches: [master, develop] | ||
pull_request: | ||
branches: [master] | ||
schedule: | ||
- cron: '0 3 * * */2' | ||
|
||
permissions: | ||
security-events: write | ||
actions: read | ||
contents: read | ||
|
||
jobs: | ||
analyse: | ||
name: Analyse | ||
runs-on: ubuntu-latest | ||
|
||
steps: | ||
- name: Checkout repository | ||
uses: actions/checkout@v4 | ||
with: | ||
fetch-depth: 2 | ||
|
||
- name: Initialize CodeQL | ||
uses: github/codeql-action/init@v3 | ||
with: | ||
languages: go | ||
|
||
- name: Perform CodeQL Analysis | ||
uses: github/codeql-action/analyze@v3 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,2 @@ | ||
/swap-reaper | ||
/vendor |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,2 @@ | ||
[files] | ||
extend-exclude = [ "go.sum", "vendor" ] |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,201 @@ | ||
Apache License | ||
Version 2.0, January 2004 | ||
http://www.apache.org/licenses/ | ||
|
||
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION | ||
|
||
1. Definitions. | ||
|
||
"License" shall mean the terms and conditions for use, reproduction, | ||
and distribution as defined by Sections 1 through 9 of this document. | ||
|
||
"Licensor" shall mean the copyright owner or entity authorized by | ||
the copyright owner that is granting the License. | ||
|
||
"Legal Entity" shall mean the union of the acting entity and all | ||
other entities that control, are controlled by, or are under common | ||
control with that entity. For the purposes of this definition, | ||
"control" means (i) the power, direct or indirect, to cause the | ||
direction or management of such entity, whether by contract or | ||
otherwise, or (ii) ownership of fifty percent (50%) or more of the | ||
outstanding shares, or (iii) beneficial ownership of such entity. | ||
|
||
"You" (or "Your") shall mean an individual or Legal Entity | ||
exercising permissions granted by this License. | ||
|
||
"Source" form shall mean the preferred form for making modifications, | ||
including but not limited to software source code, documentation | ||
source, and configuration files. | ||
|
||
"Object" form shall mean any form resulting from mechanical | ||
transformation or translation of a Source form, including but | ||
not limited to compiled object code, generated documentation, | ||
and conversions to other media types. | ||
|
||
"Work" shall mean the work of authorship, whether in Source or | ||
Object form, made available under the License, as indicated by a | ||
copyright notice that is included in or attached to the work | ||
(an example is provided in the Appendix below). | ||
|
||
"Derivative Works" shall mean any work, whether in Source or Object | ||
form, that is based on (or derived from) the Work and for which the | ||
editorial revisions, annotations, elaborations, or other modifications | ||
represent, as a whole, an original work of authorship. For the purposes | ||
of this License, Derivative Works shall not include works that remain | ||
separable from, or merely link (or bind by name) to the interfaces of, | ||
the Work and Derivative Works thereof. | ||
|
||
"Contribution" shall mean any work of authorship, including | ||
the original version of the Work and any modifications or additions | ||
to that Work or Derivative Works thereof, that is intentionally | ||
submitted to Licensor for inclusion in the Work by the copyright owner | ||
or by an individual or Legal Entity authorized to submit on behalf of | ||
the copyright owner. For the purposes of this definition, "submitted" | ||
means any form of electronic, verbal, or written communication sent | ||
to the Licensor or its representatives, including but not limited to | ||
communication on electronic mailing lists, source code control systems, | ||
and issue tracking systems that are managed by, or on behalf of, the | ||
Licensor for the purpose of discussing and improving the Work, but | ||
excluding communication that is conspicuously marked or otherwise | ||
designated in writing by the copyright owner as "Not a Contribution." | ||
|
||
"Contributor" shall mean Licensor and any individual or Legal Entity | ||
on behalf of whom a Contribution has been received by Licensor and | ||
subsequently incorporated within the Work. | ||
|
||
2. Grant of Copyright License. Subject to the terms and conditions of | ||
this License, each Contributor hereby grants to You a perpetual, | ||
worldwide, non-exclusive, no-charge, royalty-free, irrevocable | ||
copyright license to reproduce, prepare Derivative Works of, | ||
publicly display, publicly perform, sublicense, and distribute the | ||
Work and such Derivative Works in Source or Object form. | ||
|
||
3. Grant of Patent License. Subject to the terms and conditions of | ||
this License, each Contributor hereby grants to You a perpetual, | ||
worldwide, non-exclusive, no-charge, royalty-free, irrevocable | ||
(except as stated in this section) patent license to make, have made, | ||
use, offer to sell, sell, import, and otherwise transfer the Work, | ||
where such license applies only to those patent claims licensable | ||
by such Contributor that are necessarily infringed by their | ||
Contribution(s) alone or by combination of their Contribution(s) | ||
with the Work to which such Contribution(s) was submitted. If You | ||
institute patent litigation against any entity (including a | ||
cross-claim or counterclaim in a lawsuit) alleging that the Work | ||
or a Contribution incorporated within the Work constitutes direct | ||
or contributory patent infringement, then any patent licenses | ||
granted to You under this License for that Work shall terminate | ||
as of the date such litigation is filed. | ||
|
||
4. Redistribution. You may reproduce and distribute copies of the | ||
Work or Derivative Works thereof in any medium, with or without | ||
modifications, and in Source or Object form, provided that You | ||
meet the following conditions: | ||
|
||
(a) You must give any other recipients of the Work or | ||
Derivative Works a copy of this License; and | ||
|
||
(b) You must cause any modified files to carry prominent notices | ||
stating that You changed the files; and | ||
|
||
(c) You must retain, in the Source form of any Derivative Works | ||
that You distribute, all copyright, patent, trademark, and | ||
attribution notices from the Source form of the Work, | ||
excluding those notices that do not pertain to any part of | ||
the Derivative Works; and | ||
|
||
(d) If the Work includes a "NOTICE" text file as part of its | ||
distribution, then any Derivative Works that You distribute must | ||
include a readable copy of the attribution notices contained | ||
within such NOTICE file, excluding those notices that do not | ||
pertain to any part of the Derivative Works, in at least one | ||
of the following places: within a NOTICE text file distributed | ||
as part of the Derivative Works; within the Source form or | ||
documentation, if provided along with the Derivative Works; or, | ||
within a display generated by the Derivative Works, if and | ||
wherever such third-party notices normally appear. The contents | ||
of the NOTICE file are for informational purposes only and | ||
do not modify the License. You may add Your own attribution | ||
notices within Derivative Works that You distribute, alongside | ||
or as an addendum to the NOTICE text from the Work, provided | ||
that such additional attribution notices cannot be construed | ||
as modifying the License. | ||
|
||
You may add Your own copyright statement to Your modifications and | ||
may provide additional or different license terms and conditions | ||
for use, reproduction, or distribution of Your modifications, or | ||
for any such Derivative Works as a whole, provided Your use, | ||
reproduction, and distribution of the Work otherwise complies with | ||
the conditions stated in this License. | ||
|
||
5. Submission of Contributions. Unless You explicitly state otherwise, | ||
any Contribution intentionally submitted for inclusion in the Work | ||
by You to the Licensor shall be under the terms and conditions of | ||
this License, without any additional terms or conditions. | ||
Notwithstanding the above, nothing herein shall supersede or modify | ||
the terms of any separate license agreement you may have executed | ||
with Licensor regarding such Contributions. | ||
|
||
6. Trademarks. This License does not grant permission to use the trade | ||
names, trademarks, service marks, or product names of the Licensor, | ||
except as required for reasonable and customary use in describing the | ||
origin of the Work and reproducing the content of the NOTICE file. | ||
|
||
7. Disclaimer of Warranty. Unless required by applicable law or | ||
agreed to in writing, Licensor provides the Work (and each | ||
Contributor provides its Contributions) on an "AS IS" BASIS, | ||
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or | ||
implied, including, without limitation, any warranties or conditions | ||
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A | ||
PARTICULAR PURPOSE. You are solely responsible for determining the | ||
appropriateness of using or redistributing the Work and assume any | ||
risks associated with Your exercise of permissions under this License. | ||
|
||
8. Limitation of Liability. In no event and under no legal theory, | ||
whether in tort (including negligence), contract, or otherwise, | ||
unless required by applicable law (such as deliberate and grossly | ||
negligent acts) or agreed to in writing, shall any Contributor be | ||
liable to You for damages, including any direct, indirect, special, | ||
incidental, or consequential damages of any character arising as a | ||
result of this License or out of the use or inability to use the | ||
Work (including but not limited to damages for loss of goodwill, | ||
work stoppage, computer failure or malfunction, or any and all | ||
other commercial damages or losses), even if such Contributor | ||
has been advised of the possibility of such damages. | ||
|
||
9. Accepting Warranty or Additional Liability. While redistributing | ||
the Work or Derivative Works thereof, You may choose to offer, | ||
and charge a fee for, acceptance of support, warranty, indemnity, | ||
or other liability obligations and/or rights consistent with this | ||
License. However, in accepting such obligations, You may act only | ||
on Your own behalf and on Your sole responsibility, not on behalf | ||
of any other Contributor, and only if You agree to indemnify, | ||
defend, and hold each Contributor harmless for any liability | ||
incurred by, or claims asserted against, such Contributor by reason | ||
of your accepting any such warranty or additional liability. | ||
|
||
END OF TERMS AND CONDITIONS | ||
|
||
APPENDIX: How to apply the Apache License to your work. | ||
|
||
To apply the Apache License to your work, attach the following | ||
boilerplate notice, with the fields enclosed by brackets "[]" | ||
replaced with your own identifying information. (Don't include | ||
the brackets!) The text should be enclosed in the appropriate | ||
comment syntax for the file format. We also recommend that a | ||
file or class name and description of purpose be included on the | ||
same "printed page" as the copyright notice for easier | ||
identification within third-party archives. | ||
|
||
Copyright 2020 ESSENTIAL KAOS | ||
|
||
Licensed under the Apache License, Version 2.0 (the "License"); | ||
you may not use this file except in compliance with the License. | ||
You may obtain a copy of the License at | ||
|
||
http://www.apache.org/licenses/LICENSE-2.0 | ||
|
||
Unless required by applicable law or agreed to in writing, software | ||
distributed under the License is distributed on an "AS IS" BASIS, | ||
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
See the License for the specific language governing permissions and | ||
limitations under the License. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,125 @@ | ||
################################################################################ | ||
|
||
# This Makefile generated by GoMakeGen 3.2.0 using next command: | ||
# gomakegen --mod . | ||
# | ||
# More info: https://kaos.sh/gomakegen | ||
|
||
################################################################################ | ||
|
||
ifdef VERBOSE ## Print verbose information (Flag) | ||
VERBOSE_FLAG = -v | ||
endif | ||
|
||
ifdef PROXY ## Force proxy usage for downloading dependencies (Flag) | ||
export GOPROXY=https://proxy.golang.org/cached-only,direct | ||
endif | ||
|
||
ifdef CGO ## Enable CGO usage (Flag) | ||
export CGO_ENABLED=1 | ||
else | ||
export CGO_ENABLED=0 | ||
endif | ||
|
||
COMPAT ?= 1.19 | ||
MAKEDIR = $(dir $(realpath $(firstword $(MAKEFILE_LIST)))) | ||
GITREV ?= $(shell test -s $(MAKEDIR)/.git && git rev-parse --short HEAD) | ||
|
||
################################################################################ | ||
|
||
.DEFAULT_GOAL := help | ||
.PHONY = fmt vet all install uninstall clean deps update init vendor mod-init mod-update mod-download mod-vendor help | ||
|
||
################################################################################ | ||
|
||
all: swap-reaper ## Build all binaries | ||
|
||
swap-reaper: | ||
@echo "[36;1mBuilding swap-reaper…[0m" | ||
@go build $(VERBOSE_FLAG) -ldflags="-X main.gitrev=$(GITREV)" swap-reaper.go | ||
|
||
install: ## Install all binaries | ||
@echo "[36;1mInstalling binaries…[0m" | ||
@cp swap-reaper /usr/bin/swap-reaper | ||
|
||
uninstall: ## Uninstall all binaries | ||
@echo "[36;1mRemoving installed binaries…[0m" | ||
@rm -f /usr/bin/swap-reaper | ||
|
||
init: mod-init ## Initialize new module | ||
|
||
deps: mod-download ## Download dependencies | ||
|
||
update: mod-update ## Update dependencies to the latest versions | ||
|
||
vendor: mod-vendor ## Make vendored copy of dependencies | ||
|
||
mod-init: | ||
@echo "[37m[1/2][0m [36;1mModules initialization…[0m" | ||
ifdef MODULE_PATH ## Module path for initialization (String) | ||
@go mod init $(MODULE_PATH) | ||
else | ||
@go mod init | ||
endif | ||
|
||
@echo "[37m[2/2][0m [36;1mDependencies cleanup…[0m" | ||
ifdef COMPAT ## Compatible Go version (String) | ||
@go mod tidy $(VERBOSE_FLAG) -compat=$(COMPAT) -go=$(COMPAT) | ||
else | ||
@go mod tidy $(VERBOSE_FLAG) | ||
endif | ||
|
||
mod-update: | ||
@echo "[37m[1/4][0m [36;1mUpdating dependencies…[0m" | ||
ifdef UPDATE_ALL ## Update all dependencies (Flag) | ||
@go get -u $(VERBOSE_FLAG) all | ||
else | ||
@go get -u $(VERBOSE_FLAG) ./... | ||
endif | ||
|
||
@echo "[37m[2/4][0m [36;1mStripping toolchain info…[0m" | ||
@grep -q 'toolchain ' go.mod && go mod edit -toolchain=none || : | ||
|
||
@echo "[37m[3/4][0m [36;1mDependencies cleanup…[0m" | ||
ifdef COMPAT | ||
@go mod tidy $(VERBOSE_FLAG) -compat=$(COMPAT) | ||
else | ||
@go mod tidy $(VERBOSE_FLAG) | ||
endif | ||
|
||
@echo "[37m[4/4][0m [36;1mUpdating vendored dependencies…[0m" | ||
@test -d vendor && rm -rf vendor && go mod vendor $(VERBOSE_FLAG) || : | ||
|
||
mod-download: | ||
@echo "[36;1mDownloading dependencies…[0m" | ||
@go mod download | ||
|
||
mod-vendor: | ||
@echo "[36;1mVendoring dependencies…[0m" | ||
@rm -rf vendor && go mod vendor $(VERBOSE_FLAG) || : | ||
|
||
fmt: ## Format source code with gofmt | ||
@echo "[36;1mFormatting sources…[0m" | ||
@find . -name "*.go" -exec gofmt -s -w {} \; | ||
|
||
vet: ## Runs 'go vet' over sources | ||
@echo "[36;1mRunning 'go vet' over sources…[0m" | ||
@go vet -composites=false -printfuncs=LPrintf,TLPrintf,TPrintf,log.Debug,log.Info,log.Warn,log.Error,log.Critical,log.Print ./... | ||
|
||
clean: ## Remove generated files | ||
@echo "[36;1mRemoving built binaries…[0m" | ||
@rm -f swap-reaper | ||
|
||
help: ## Show this info | ||
@echo -e '\n\033[1mTargets:\033[0m\n' | ||
@grep -E '^[a-zA-Z_-]+:.*?## .*$$' $(MAKEFILE_LIST) \ | ||
| awk 'BEGIN {FS = ":.*?## "}; {printf " \033[33m%-9s\033[0m %s\n", $$1, $$2}' | ||
@echo -e '\n\033[1mVariables:\033[0m\n' | ||
@grep -E '^ifdef [A-Z_]+ .*?## .*$$' $(abspath $(lastword $(MAKEFILE_LIST))) \ | ||
| sed 's/ifdef //' \ | ||
| sort -h \ | ||
| awk 'BEGIN {FS = " .*?## "}; {printf " \033[32m%-11s\033[0m %s\n", $$1, $$2}' | ||
@echo -e '' | ||
@echo -e '\033[90mGenerated by GoMakeGen 3.2.0\033[0m\n' | ||
|
||
################################################################################ |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,2 +1,41 @@ | ||
# swap-reaper | ||
Service to periodically clean swap memory | ||
<p align="center"><a href="#readme"><img src=".github/images/card.svg"/></a></p> | ||
|
||
<p align="center"> | ||
<a href="https://kaos.sh/l/swap-reaper"><img src="https://kaos.sh/l/2789fa8237b648b33b22.svg" alt="Code Climate Maintainability" /></a> | ||
<a href="https://kaos.sh/y/swap-reaper"><img src="https://kaos.sh/y/47f9bd9f8b654f299891299b8df32e71.svg" alt="Codacy" /></a> | ||
<a href="https://kaos.sh/w/swap-reaper/ci"><img src="https://kaos.sh/w/swap-reaper/ci.svg" alt="GitHub Actions CI Status" /></a> | ||
<a href="https://kaos.sh/w/swap-reaper/codeql"><img src="https://kaos.sh/w/swap-reaper/codeql.svg" alt="GitHub Actions CodeQL Status" /></a> | ||
<a href="#license"><img src=".github/images/license.svg"/></a> | ||
</p> | ||
|
||
<p align="center"><a href="#installation">Installation</a> • <a href="#ci-status">CI Status</a> • <a href="#contributing">Contributing</a> • <a href="#license">License</a></p> | ||
|
||
<br/> | ||
|
||
`swap-reaper` is a service to periodically clean swap memory. | ||
|
||
### Installation | ||
|
||
#### From [ESSENTIAL KAOS Public Repository](https://kaos.sh/kaos-repo) | ||
|
||
```bash | ||
sudo dnf install -y https://pkgs.kaos.st/kaos-repo-latest.el$(grep 'CPE_NAME' /etc/os-release | tr -d '"' | cut -d':' -f5).noarch.rpm | ||
sudo dnf install swap-reaper | ||
``` | ||
|
||
### CI Status | ||
|
||
| Branch | Status | | ||
|--------|----------| | ||
| `master` | [![CI](https://kaos.sh/w/swap-reaper/ci.svg?branch=master)](https://kaos.sh/w/swap-reaper/ci?query=branch:master) | | ||
| `develop` | [![CI](https://kaos.sh/w/swap-reaper/ci.svg?branch=develop)](https://kaos.sh/w/swap-reaper/ci?query=branch:develop) | | ||
|
||
### Contributing | ||
|
||
Before contributing to this project please read our [Contributing Guidelines](https://github.com/essentialkaos/contributing-guidelines#contributing-guidelines). | ||
|
||
### License | ||
|
||
[Apache License, Version 2.0](http://www.apache.org/licenses/LICENSE-2.0) | ||
|
||
<p align="center"><a href="https://essentialkaos.com"><img src="https://gh.kaos.st/ekgh.svg"/></a></p> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,36 @@ | ||
# Security Policies and Procedures | ||
|
||
This document outlines security procedures and general policies for all | ||
ESSENTIAL KAOS projects. | ||
|
||
* [Reporting a Bug](#reporting-a-bug) | ||
* [Disclosure Policy](#disclosure-policy) | ||
|
||
## Reporting a Bug | ||
|
||
The ESSENTIAL KAOS team and community take all security bugs in our projects | ||
very seriously. Thank you for improving the security of our project. We | ||
appreciate your efforts and responsible disclosure and will make every effort | ||
to acknowledge your contributions. | ||
|
||
Report security bugs by emailing our security team at security@essentialkaos.com. | ||
|
||
The security team will acknowledge your email within 48 hours and will send a | ||
more detailed response within 48 hours, indicating the next steps in handling | ||
your report. After the initial reply to your report, the security team will | ||
endeavor to keep you informed of the progress towards a fix and full | ||
announcement, and may ask for additional information or guidance. | ||
|
||
Report security bugs in third-party dependencies to the person or team | ||
maintaining the dependencies. | ||
|
||
## Disclosure Policy | ||
|
||
When the security team receives a security bug report, they will assign it to a | ||
primary handler. This person will coordinate the fix and release process, | ||
involving the following steps: | ||
|
||
* Confirm the problem and determine the affected versions; | ||
* Audit code to find any similar potential problems; | ||
* Prepare fixes for all releases still under maintenance. These fixes will be | ||
released as fast as possible. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,23 @@ | ||
# This is configuration file for swap-reaper | ||
|
||
[limits] | ||
|
||
# If 1 min LA is greater than given value cleaning will be postponed (> 0.1) | ||
max-la: 1.0 | ||
|
||
# Max time in minutes to wait for LA to normalize (1-86,400) | ||
max-wait: 15 | ||
|
||
[log] | ||
|
||
# Log file dir | ||
dir: /var/log/swap-reaper | ||
|
||
# Path to log file | ||
file: {log:dir}/swap-reaper.log | ||
|
||
# Log permissions | ||
perms: 644 | ||
|
||
# Default log level (debug/info/warn/error/crit) | ||
level: info |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,9 @@ | ||
/var/log/swap-reaper/*.log { | ||
weekly | ||
rotate 8 | ||
copytruncate | ||
delaycompress | ||
compress | ||
notifempty | ||
missingok | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,16 @@ | ||
[Unit] | ||
Description=Tool to periodically clean swap memory | ||
Documentation=https://kaos.sh/swap-reaper | ||
After=network-online.target remote-fs.target nss-lookup.target | ||
Wants=network-online.target | ||
|
||
[Service] | ||
Type=simple | ||
ExecStart=/usr/bin/swap-reaper -c /etc/swap-reaper.knf | ||
ExecReload=/bin/kill -s HUP $MAINPID | ||
ExecStop=/bin/kill -s TERM $MAINPID | ||
StandardError=file:/var/log/swap-reaper/startup.log | ||
PrivateTmp=true | ||
|
||
[Install] | ||
WantedBy=multi-user.target |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,109 @@ | ||
################################################################################ | ||
|
||
%global crc_check pushd ../SOURCES ; sha512sum -c %{SOURCE100} ; popd | ||
|
||
################################################################################ | ||
|
||
%define debug_package %{nil} | ||
|
||
################################################################################ | ||
|
||
%define _logdir %{_localstatedir}/log | ||
|
||
################################################################################ | ||
|
||
Summary: Tool to periodically clean swap memory | ||
Name: swap-reaper | ||
Version: 0.0.1 | ||
Release: 0%{?dist} | ||
Group: Applications/System | ||
License: Apache License, Version 2.0 | ||
URL: https://kaos.sh/swap-reaper | ||
|
||
Source0: https://source.kaos.st/%{name}/%{name}-%{version}.tar.bz2 | ||
|
||
Source100: checksum.sha512 | ||
|
||
BuildRoot: %{_tmppath}/%{name}-%{version}-%{release}-root-%(%{__id_u} -n) | ||
|
||
BuildRequires: golang >= 1.22 | ||
|
||
Requires: systemd | ||
|
||
Provides: %{name} = %{version}-%{release} | ||
|
||
################################################################################ | ||
|
||
%description | ||
Tool to periodically clean swap memory. | ||
|
||
################################################################################ | ||
|
||
%prep | ||
%{crc_check} | ||
|
||
%setup -q | ||
if [[ ! -d "%{name}/vendor" ]] ; then | ||
echo -e "----\nThis package requires vendored dependencies\n----" | ||
exit 1 | ||
elif [[ -f "%{name}/%{name}" ]] ; then | ||
echo -e "----\nSources must not contain precompiled binaries\n----" | ||
exit 1 | ||
fi | ||
|
||
%build | ||
pushd %{name} | ||
%{__make} %{?_smp_mflags} all | ||
cp LICENSE .. | ||
popd | ||
|
||
%install | ||
rm -rf %{buildroot} | ||
|
||
install -dDm 755 %{buildroot}%{_bindir} | ||
install -dDm 755 %{buildroot}%{_sysconfdir}/logrotate.d | ||
install -dDm 755 %{buildroot}%{_unitdir} | ||
install -dDm 755 %{buildroot}%{_logdir}/%{name} | ||
|
||
install -pm 755 %{name}/%{name} \ | ||
%{buildroot}%{_bindir}/ | ||
|
||
install -pm 644 %{name}/common/%{name}.knf \ | ||
%{buildroot}%{_sysconfdir}/ | ||
|
||
install -pm 644 %{name}/common/%{name}.logrotate \ | ||
%{buildroot}%{_sysconfdir}/logrotate.d/%{name} | ||
|
||
install -pm 644 %{name}/common/%{name}.service \ | ||
%{buildroot}%{_unitdir}/ | ||
|
||
%clean | ||
rm -rf %{buildroot} | ||
|
||
%preun | ||
if [[ $1 -eq 0 ]] ; then | ||
systemctl --no-reload disable %{name}.service &>/dev/null || : | ||
systemctl stop %{name}.service &>/dev/null || : | ||
fi | ||
|
||
%postun | ||
if [[ $1 -ge 1 ]] ; then | ||
systemctl daemon-reload &>/dev/null || : | ||
fi | ||
|
||
################################################################################ | ||
|
||
%files | ||
%defattr(-,root,root,-) | ||
%doc LICENSE | ||
%dir %{_logdir}/%{name} | ||
%config(noreplace) %{_sysconfdir}/%{name}.knf | ||
%config(noreplace) %{_sysconfdir}/logrotate.d/%{name} | ||
%{_unitdir}/%{name}.service | ||
%{_bindir}/%{name} | ||
|
||
################################################################################ | ||
|
||
%changelog | ||
* Thu Sep 12 2024 Anton Novojilov <andy@essentialkaos.com> - 0.0.1-0 | ||
- The very first version |
Large diffs are not rendered by default.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,10 @@ | ||
module github.com/essentialkaos/swap-reaper | ||
|
||
go 1.21 | ||
|
||
require github.com/essentialkaos/ek/v13 v13.5.1 | ||
|
||
require ( | ||
github.com/essentialkaos/depsy v1.3.0 // indirect | ||
golang.org/x/sys v0.25.0 // indirect | ||
) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,14 @@ | ||
github.com/essentialkaos/check v1.4.0 h1:kWdFxu9odCxUqo1NNFNJmguGrDHgwi3A8daXX1nkuKk= | ||
github.com/essentialkaos/check v1.4.0/go.mod h1:LMKPZ2H+9PXe7Y2gEoKyVAwUqXVgx7KtgibfsHJPus0= | ||
github.com/essentialkaos/depsy v1.3.0 h1:CN7bRgBU2jGTHSkg/Sh38eDUn7cvmaTp2sxFt2HpFeU= | ||
github.com/essentialkaos/depsy v1.3.0/go.mod h1:kpiTAV17dyByVnrbNaMcZt2jRwvuXClUYOzpyJQwtG8= | ||
github.com/essentialkaos/ek/v13 v13.5.1 h1:xkr3d5uAzs69AqI0oKHjjZIsowKdR117AMBv+Dop4Fk= | ||
github.com/essentialkaos/ek/v13 v13.5.1/go.mod h1:KBOtJlrIC2etc/EXvMdbz1JeKmtkuVdK6uRW/ap0OPM= | ||
github.com/kr/pretty v0.3.1 h1:flRD4NNwYAUpkphVc1HcthR4KEIFJ65n8Mw5qdRn3LE= | ||
github.com/kr/pretty v0.3.1/go.mod h1:hoEshYVHaxMs3cyo3Yncou5ZscifuDolrwPKZanG3xk= | ||
github.com/kr/text v0.2.0 h1:5Nx0Ya0ZqY2ygV366QzturHI13Jq95ApcVaJBhpS+AY= | ||
github.com/kr/text v0.2.0/go.mod h1:eLer722TekiGuMkidMxC/pM04lWEeraHUUmBw8l2grE= | ||
github.com/rogpeppe/go-internal v1.11.0 h1:cWPaGQEPrBb5/AsnsZesgZZ9yb1OQ+GOISoDNXVBh4M= | ||
github.com/rogpeppe/go-internal v1.11.0/go.mod h1:ddIwULY96R17DhadqLgMfk9H9tvdUzkipdSkR5nkCZA= | ||
golang.org/x/sys v0.25.0 h1:r+8e+loiHxRqhXVl6ML1nO3l1+oFoWbnlu2Ehimmi34= | ||
golang.org/x/sys v0.25.0/go.mod h1:/VUhepiaJMQUp4+oa/7Zr1D23ma6VTLIYjOOTFZPUcA= |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,28 @@ | ||
package main | ||
|
||
// ////////////////////////////////////////////////////////////////////////////////// // | ||
// // | ||
// Copyright (c) 2024 ESSENTIAL KAOS // | ||
// Apache License, Version 2.0 <https://www.apache.org/licenses/LICENSE-2.0> // | ||
// // | ||
// ////////////////////////////////////////////////////////////////////////////////// // | ||
|
||
import ( | ||
_ "embed" | ||
|
||
DAEMON "github.com/essentialkaos/swap-reaper/daemon" | ||
) | ||
|
||
// ////////////////////////////////////////////////////////////////////////////////// // | ||
|
||
//go:embed go.mod | ||
var gomod []byte | ||
|
||
// gitrev is short hash of the latest git commit | ||
var gitrev string | ||
|
||
// ////////////////////////////////////////////////////////////////////////////////// // | ||
|
||
func main() { | ||
DAEMON.Run(gitrev, gomod) | ||
} |