Skip to content

Commit

Permalink
Merge pull request #1 from linuxfoundation/ems/lint
Browse files Browse the repository at this point in the history
Fixes for super-lint and remove Pipfile.lock
  • Loading branch information
emsearcy authored Apr 4, 2024
2 parents cd0eef9 + c803bc7 commit fbb4190
Show file tree
Hide file tree
Showing 6 changed files with 231 additions and 370 deletions.
4 changes: 3 additions & 1 deletion .github/workflows/super-linter.yml
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,9 @@ jobs:
fetch-depth: 0

- name: Super-linter
uses: super-linter/super-linter@v6.3.0
uses: super-linter/super-linter/slim@v6.3.0
env:
# To report GitHub Actions status checks
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
# Dependency resolution not supporting Pipfile, apparently.
VALIDATE_PYTHON_PYLINT: "false"
8 changes: 8 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
# Copyright The Linux Foundation and each contributor to LFX.
# SPDX-License-Identifier: MIT

# Normally, committing lockfiles is a best practice. But 1) this is a local
# shell utility, run sporadically and 2) committing a lockfile means keeping it
# up to date every time there is a security issue. In this case, we're going to
# assume "follow latest" for each use/installation.
Pipfile.lock
272 changes: 0 additions & 272 deletions Pipfile.lock

This file was deleted.

7 changes: 3 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,9 +16,8 @@ For more details, run the script with the `--help` option.

## Setup & Usage for Linux Foundation / LFX sites

Recommend installation is via a pipenv-managed virtualenv (with consistent
package versions tracked in the lock file), and pyenv to install the supported
Python release if your system doesn't have Python 3.11.
Recommend installation is via a pipenv-managed virtualenv, and pyenv to install
the supported Python release if your system doesn't have Python 3.11.

Be sure to set `AWS_PROFILE` with MFA and/or SSO authentication helpers before
running the script.
Expand All @@ -37,7 +36,7 @@ the current user. This tool has been developed against Python 3.11 and may not
work on other versions.

```bash
pip3.11 install --user boto3
pip3.11 install --user boto3 trieregex
# Optional: to set AWS_PROFILE or other parameters via .env:
# pip3.11 install --user python-dotenv
./cdn_maintenance_toggle.py --template lfx-maintenance.html -v --disable-sites "*.platform.linuxfoundation.org" "*.lfx.dev"
Expand Down
Loading

0 comments on commit fbb4190

Please sign in to comment.