Skip to content
GitLab
Explore
Sign in
Register
Primary navigation
Search or go to…
Project
M
My Nagios Plugin Wrapper
Manage
Activity
Members
Labels
Plan
Issues
Issue boards
Milestones
Wiki
Code
Merge requests
Repository
Branches
Commits
Tags
Repository graph
Compare revisions
Snippets
Build
Pipelines
Jobs
Pipeline schedules
Artifacts
Deploy
Releases
Package registry
Model registry
Operate
Environments
Terraform modules
Monitor
Incidents
Analyze
Value stream analytics
Contributor analytics
CI/CD analytics
Repository analytics
Model experiments
Help
Help
Support
GitLab documentation
Compare GitLab plans
Community forum
Contribute to GitLab
Provide feedback
Keyboard shortcuts
?
Snippets
Groups
Projects
Show more breadcrumbs
shore
My Nagios Plugin Wrapper
Commits
bb192126
Commit
bb192126
authored
3 years ago
by
nimrod
Browse files
Options
Downloads
Patches
Plain Diff
Document development and release.
parent
d3e83c48
No related branches found
No related tags found
No related merge requests found
Pipeline
#1983
passed
3 years ago
Stage: .pre
Stage: build
Stage: test
Changes
2
Pipelines
1
Show whitespace changes
Inline
Side-by-side
Showing
2 changed files
Makefile
+4
-0
4 additions, 0 deletions
Makefile
README.rst
+31
-0
31 additions, 0 deletions
README.rst
with
35 additions
and
0 deletions
Makefile
+
4
−
0
View file @
bb192126
...
...
@@ -7,3 +7,7 @@ dist/mnpw: mnpw/*.py pyproject.toml *.rst LICENSE.txt
.PHONY
:
clean
clean
:
git clean
--force
-X
-d
.PHONY
:
bats
bats
:
all
bats tests/
This diff is collapsed.
Click to expand it.
README.rst
+
31
−
0
View file @
bb192126
...
...
@@ -48,6 +48,37 @@ plugin handling useful and would want to use it. The package is not published to
PyPI so your best option is getting a direct download of the wheel package from
the `releases pages <https://git.shore.co.il/shore/mnpw/-/releases>`_.
Development
-----------
For local development, the following is required:
- Python 3.6 or newer.
- `Poetry <https://python-poetry.org/>`_.
- `Bats <https://bats-core.readthedocs.io/en/stable/>`_.
- Make.
To run all of the tests locally:
.. code:: shell
poetry install
poetry run pre-commit run --all-files
poetry run pytest
poetry run make bats
All of those tests (and more) run in the `CI pipeline
<https://git.shore.co.il/shore/mnpw/-/pipelines>`_ on each push.
To release a new verion:
.. code:: shell
poetry run bumpversion major|minor|patch
This will commit the version change, tag and push it and the pipeline will
release a new version.
License
-------
...
...
This diff is collapsed.
Click to expand it.
Preview
0%
Loading
Try again
or
attach a new file
.
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Save comment
Cancel
Please
register
or
sign in
to comment