saltext.github 1.0.0__tar.gz

saltext_github-1.0.0/.copier-answers.yml

@@ -0,0 +1,28 @@
+# Autogenerated. Do not edit this by hand, use `copier update`.
+---
+_commit: 0.3.7
+_src_path: https://github.com/lkubb/salt-extension-copier
+author: EITR Technologies, LLC
+author_email: devops@eitr.tech
+coc_contact: devops@eitr.tech
+copyright_begin: 2024
+deploy_docs: rolling
+docs_url: https://salt-extensions.github.io/saltext-github/
+integration_name: GitHub
+license: apache
+loaders:
+  - module
+  - state
+max_salt_version: 3007
+no_saltext_namespace: false
+package_name: github
+project_name: github
+python_requires: '3.8'
+salt_version: '3005'
+source_url: https://github.com/salt-extensions/saltext-github
+ssh_fixtures: false
+summary: Salt Extension for interacting with GitHub
+test_containers: false
+tracker_url: https://github.com/salt-extensions/saltext-github/issues
+url: https://github.com/salt-extensions/saltext-github
+workflows: org

saltext_github-1.0.0/.coveragerc

@@ -0,0 +1,42 @@
+[run]
+branch = True
+cover_pylib = False
+relative_files = True
+parallel = True
+concurrency = multiprocessing
+
+omit =
+  .nox/*
+  setup.py
+
+[report]
+# Regexes for lines to exclude from consideration
+exclude_lines =
+    # Have to re-enable the standard pragma
+    pragma: no cover
+
+    # Don't complain about missing debug-only code:
+    def __repr__
+
+    # Don't complain if tests don't hit defensive assertion code:
+    raise AssertionError
+    raise NotImplementedError
+
+    # Don't complain if non-runnable code isn't run:
+    if 0:
+    if False:
+    if __name__ == .__main__.:
+
+omit =
+  .nox/*
+  setup.py
+
+
+ignore_errors = True
+
+[paths]
+source =
+  saltext/github
+  src/saltext/github
+testsuite =
+  tests/

saltext_github-1.0.0/.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,48 @@
+---
+name: Bug report
+about: Create a report to help us improve
+title: "[BUG]"
+labels: bug, needs-triage
+assignees: ''
+
+---
+
+**Description**
+A clear and concise description of what the bug is.
+
+**Setup**
+(Please provide relevant configs and/or SLS files (be sure to remove sensitive info. There is no general set-up of Salt.)
+
+Please be as specific as possible and give set-up details.
+
+- [ ] on-prem machine
+- [ ] VM (Virtualbox, KVM, etc. please specify)
+- [ ] VM running on a cloud service, please be explicit and add details
+- [ ] container (Kubernetes, Docker, containerd, etc. please specify)
+- [ ] or a combination, please be explicit
+- [ ] jails if it is FreeBSD
+- [ ] classic packaging
+- [ ] onedir packaging
+- [ ] used bootstrap to install
+
+
+**Steps to Reproduce the behavior**
+(Include debug logs if possible and relevant)
+
+**Expected behavior**
+A clear and concise description of what you expected to happen.
+
+**Screenshots**
+If applicable, add screenshots to help explain your problem.
+
+**Versions Report**
+<details><summary>salt --versions-report</summary>
+(Provided by running salt --versions-report. Please also mention any differences in master/minion versions.)
+
+```yaml
+PASTE HERE
+```
+</details>
+
+**Additional context**
+Add any other context about the problem here.

saltext_github-1.0.0/.github/ISSUE_TEMPLATE/config.yml

@@ -0,0 +1,14 @@
+blank_issues_enabled: true
+contact_links:
+  - name: Salt Community Slack
+    url: https://saltstackcommunity.slack.com/
+    about: Please ask and answer questions here.
+  - name: Salt-Users Forum
+    url: https://groups.google.com/forum/#!forum/salt-users
+    about: Please ask and answer questions here.
+  - name: Salt on LiberaChat
+    url: https://web.libera.chat/#salt
+    about: Please ask and answer questions here.
+  - name: Security vulnerabilities
+    email: saltproject-security.pdl@broadcom.com
+    about: Please report security vulnerabilities here.

saltext_github-1.0.0/.github/ISSUE_TEMPLATE/docs.md

@@ -0,0 +1,23 @@
+---
+name: Docs
+about: Issue related to Salt Documentation
+title: "[DOCS]"
+labels: documentation, needs-triage
+assignees: ''
+
+---
+
+**Description**
+A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
+
+**Suggested Fix**
+What did you expect to see in the documentation that is missing or needs updating?
+
+**Type of documentation**
+This could be module documentation or a guide.
+
+**Location or format of documentation**
+Insert page URL if applicable.
+
+**Additional context**
+Add any other context or screenshots here.

saltext_github-1.0.0/.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,20 @@
+---
+name: Feature request
+about: Suggest an idea for this project
+title: "[FEATURE REQUEST]"
+labels: feature, needs-triage
+assignees: ''
+
+---
+
+**Is your feature request related to a problem? Please describe.**
+A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
+
+**Describe the solution you'd like**
+A clear and concise description of what you want to happen.
+
+**Describe alternatives you've considered**
+A clear and concise description of any alternative solutions or features you've considered.
+
+**Additional context**
+Add any other context or screenshots about the feature request here.

saltext_github-1.0.0/.github/ISSUE_TEMPLATE/tech-debt.md

@@ -0,0 +1,13 @@
+---
+name: Tech Debt
+about: Issue is related to tech debt. This includes compatibility changes for newer versions of software and OSes that salt interacts with.
+title: "[TECH DEBT]"
+labels: tech-debt
+assignees: ''
+
+---
+
+### Description of the tech debt to be addressed, include links and screenshots
+
+### Versions Report
+(Provided by running `salt --versions-report`. Please also mention any differences in master/minion versions.)

saltext_github-1.0.0/.github/ISSUE_TEMPLATE.md

@@ -0,0 +1,11 @@
+### Description of Issue
+<!-- Note: Please direct questions to the salt-users google group, Slack, IRC, etc. Only post issues and feature requests here -->
+
+### Setup
+(Please provide relevant configs and/or SLS files (Be sure to remove sensitive info).)
+
+### Steps to Reproduce Issue
+(Include debug logs if possible and relevant.)
+
+### Versions Report
+(Provided by running `salt --versions-report`. Please also mention any differences in master/minion versions.)

saltext_github-1.0.0/.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,24 @@
+### What does this PR do?
+
+### What issues does this PR fix or reference?
+Fixes:
+
+### Previous Behavior
+Remove this section if not relevant
+
+### New Behavior
+Remove this section if not relevant
+
+### Merge requirements satisfied?
+**[NOTICE] Bug fixes or features added to Salt require tests.**
+<!-- Please review the [test documentation](https://docs.saltproject.io/en/master/topics/tutorials/writing_tests.html) for details on how to implement tests into Salt's test suite. -->
+- [ ] Docs
+- [ ] Changelog - https://docs.saltproject.io/en/master/topics/development/changelog.html
+- [ ] Tests written/updated
+
+### Commits signed with GPG?
+Yes/No
+
+Please review [Salt's Contributing Guide](https://docs.saltproject.io/en/master/topics/development/contributing.html) for best practices.
+
+See GitHub's [page on GPG signing](https://help.github.com/articles/signing-commits-using-gpg/) for more information about signing commits with GPG.

saltext_github-1.0.0/.github/workflows/pr.yml

@@ -0,0 +1,21 @@
+name: Pull Request or Push
+
+on:
+  push:
+    branches:
+      - 'main'  # Run on pushes to main
+    tags-ignore:
+      - '*'   # Ignore pushes to tags
+  pull_request:
+
+jobs:
+  call_central_workflow:
+    name: CI
+    uses: salt-extensions/central-artifacts/.github/workflows/ci.yml@main
+    with:
+      deploy-docs: true
+    permissions:
+      contents: write
+      id-token: write
+      pages: write
+      pull-requests: read

saltext_github-1.0.0/.github/workflows/tag.yml

@@ -0,0 +1,33 @@
+name: Tagged Releases
+
+on:
+  push:
+    tags:
+      - "v*"  # Only tags starting with "v" for "v1.0.0", etc.
+
+jobs:
+  get_tag_version:
+    runs-on: ubuntu-latest
+    outputs:
+      version: ${{ steps.get_version.outputs.version }}
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+
+      - name: Extract tag name
+        id: get_version
+        run: echo "version=$(echo ${GITHUB_REF#refs/tags/v})" >> $GITHUB_OUTPUT
+
+  call_central_workflow:
+    needs: get_tag_version
+    uses: salt-extensions/central-artifacts/.github/workflows/ci.yml@main
+    with:
+      deploy-docs: true
+      release: true
+      version: ${{ needs.get_tag_version.outputs.version }}
+    permissions:
+      contents: write
+      id-token: write
+      pages: write
+      pull-requests: read
+    secrets: inherit

saltext_github-1.0.0/.gitignore

@@ -0,0 +1,135 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+pip-wheel-metadata/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+.python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# Ignore the setuptools_scm auto-generated version module
+src/saltext/github/version.py
+
+# Ignore CI generated artifacts
+artifacts/

saltext_github-1.0.0/.pre-commit-config.yaml

@@ -0,0 +1,139 @@
+---
+minimum_pre_commit_version: 2.4.0
+repos:
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v4.6.0
+    hooks:
+      - id: check-merge-conflict  # Check for files that contain merge conflict strings.
+      - id: trailing-whitespace   # Trims trailing whitespace.
+        args: [--markdown-linebreak-ext=md]
+      - id: mixed-line-ending     # Replaces or checks mixed line ending.
+        args: [--fix=lf]
+      - id: end-of-file-fixer     # Makes sure files end in a newline and only a newline.
+      - id: check-merge-conflict  # Check for files that contain merge conflict strings.
+      - id: check-ast             # Simply check whether files parse as valid python.
+
+  # ----- Formatting ---------------------------------------------------------------------------->
+  - repo: https://github.com/saltstack/pre-commit-remove-import-headers
+    rev: 1.1.0
+    hooks:
+      - id: remove-import-headers
+
+  - repo: local
+    hooks:
+      - id: check-cli-examples
+        name: Check CLI examples on execution modules
+        entry: python .pre-commit-hooks/check-cli-examples.py
+        language: system
+        files: ^src/saltext/github/modules/.*\.py$
+
+  - repo: local
+    hooks:
+      - id: check-docs
+        name: Check rST doc files exist for modules/states
+        entry: python .pre-commit-hooks/make-autodocs.py
+        language: system
+        pass_filenames: false
+
+  - repo: https://github.com/s0undt3ch/salt-rewrite
+    # Automatically rewrite code with known rules
+    rev: 2.5.2
+    hooks:
+      - id: salt-rewrite
+        alias: rewrite-docstrings
+        name: Salt extensions docstrings auto-fixes
+        files: ^src/saltext/github/.*\.py$
+        args: [--silent]
+
+  - repo: https://github.com/s0undt3ch/salt-rewrite
+    # Automatically rewrite code with known rules
+    rev: 2.5.2
+    hooks:
+      - id: salt-rewrite
+        alias: rewrite-tests
+        name: Rewrite the test suite
+        files: ^tests/.*\.py$
+        args: [--silent, -E, fix_docstrings]
+
+  - repo: https://github.com/asottile/pyupgrade
+    rev: v3.15.2
+    hooks:
+      - id: pyupgrade
+        name: Rewrite Code to be Py3.8+
+        args: [
+          --py38-plus
+        ]
+        exclude: src/saltext/github/version.py
+
+  - repo: https://github.com/PyCQA/isort
+    rev: 5.13.2
+    hooks:
+      - id: isort
+        args: [
+          --py 38,
+        ]
+        exclude: src/saltext/github/(__init__|version).py
+
+  - repo: https://github.com/psf/black
+    rev: 24.2.0
+    hooks:
+      - id: black
+        args: [-l 100]
+        exclude: src/saltext/github/version.py
+
+  - repo: https://github.com/adamchainz/blacken-docs
+    rev: 1.16.0
+    hooks:
+      - id: blacken-docs
+        args: [--skip-errors]
+        files: ^(docs/.*\.rst|src/saltext/github/.*\.py)$
+        additional_dependencies:
+          - black==24.2.0
+  # <---- Formatting -----------------------------------------------------------------------------
+
+  # ----- Security ------------------------------------------------------------------------------>
+  - repo: https://github.com/PyCQA/bandit
+    rev: 1.7.8
+    hooks:
+      - id: bandit
+        alias: bandit-salt
+        name: Run bandit against the code base
+        args: [--silent, -lll, --skip, B701]
+        exclude: src/saltext/github/version.py
+  - repo: https://github.com/PyCQA/bandit
+    rev: 1.7.8
+    hooks:
+      - id: bandit
+        alias: bandit-tests
+        name: Run bandit against the test suite
+        args: [--silent, -lll, --skip, B701]
+        files: ^tests/.*
+  # <---- Security -------------------------------------------------------------------------------
+
+  # ----- Code Analysis ------------------------------------------------------------------------->
+  - repo: https://github.com/saltstack/mirrors-nox
+    rev: v2022.11.21
+    hooks:
+      - id: nox
+        alias: lint-src
+        name: Lint Source Code
+        files: ^((setup|noxfile)|src/.*)\.py$
+        require_serial: true
+        args:
+          - -e
+          - lint-code-pre-commit
+          - --
+
+  - repo: https://github.com/saltstack/mirrors-nox
+    rev: v2022.11.21
+    hooks:
+      - id: nox
+        alias: lint-tests
+        name: Lint Tests
+        files: ^tests/.*\.py$
+        require_serial: true
+        args:
+          - -e
+          - lint-tests-pre-commit
+          - --
+  # <---- Code Analysis --------------------------------------------------------------------------

saltext_github-1.0.0/.pre-commit-hooks/check-cli-examples.py

@@ -0,0 +1,64 @@
+import ast
+import pathlib
+import re
+import sys
+
+CODE_ROOT = pathlib.Path(__file__).resolve().parent.parent
+EXECUTION_MODULES_PATH = CODE_ROOT / "src" / "saltext" / "github" / "modules"
+
+
+def check_cli_examples(files):
+    """
+    Check that every function on every execution module provides a CLI example
+    """
+    errors = 0
+    for file in files:
+        path = pathlib.Path(file).resolve()
+        try:
+            relpath = path.relative_to(EXECUTION_MODULES_PATH)
+            if str(relpath.parent) != ".":
+                # We don't want to check nested packages
+                continue
+        except ValueError:
+            # We're only interested in execution modules
+            continue
+        module = ast.parse(path.read_text(), filename=str(path))
+        for funcdef in [node for node in module.body if isinstance(node, ast.FunctionDef)]:
+            if funcdef.name.startswith("_"):
+                # We're not interested in internal functions
+                continue
+
+            docstring = ast.get_docstring(funcdef, clean=False)
+            if not docstring:
+                errors += 1
+                print(
+                    "The function {!r} on '{}' does not have a docstring".format(
+                        funcdef.name,
+                        path.relative_to(CODE_ROOT),
+                    ),
+                    file=sys.stderr,
+                )
+                continue
+
+            if _check_cli_example_present(docstring) is False:
+                errors += 1
+                print(
+                    "The function {!r} on '{}' does not have a 'CLI Example:' in it's docstring".format(
+                        funcdef.name,
+                        path.relative_to(CODE_ROOT),
+                    ),
+                    file=sys.stderr,
+                )
+                continue
+    sys.exit(errors)
+
+
+CLI_EXAMPLE_PRESENT_RE = re.compile(r"CLI Example(?:s)?:")
+
+
+def _check_cli_example_present(docstring):
+    return CLI_EXAMPLE_PRESENT_RE.search(docstring) is not None
+
+
+if __name__ == "__main__":
+    check_cli_examples(sys.argv[1:])