https://github.com/mateusz-grzelinski/actionlint-py

Same as https://github.com/shellcheck-py/shellcheck-py but for actionlint
https://github.com/mateusz-grzelinski/actionlint-py

Last synced: 2 months ago
JSON representation

Same as https://github.com/shellcheck-py/shellcheck-py but for actionlint

• Host: GitHub
• URL: https://github.com/mateusz-grzelinski/actionlint-py
• Owner: Mateusz-Grzelinski
• License: mit
• Created: 2023-01-13T10:53:50.000Z (about 2 years ago)
• Default Branch: main
• Last Pushed: 2024-10-02T13:15:27.000Z (4 months ago)
• Last Synced: 2024-11-03T14:51:53.486Z (3 months ago)
• Language: Python
• Size: 163 KB
• Stars: 9
• Watchers: 2
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README-DEV.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Workflows

Workflows take care of (todo update):

- checking for updates every day: [check-for-update.yml](.github/workflows/check-for-update.yml)

  and [auto_update_main.py](_custom_build/auto_update_main.py)

- tagging a git commit using only version in file: `_custom_build/VERSION_ACTIONLINT.txt`

  in [tag.yml](.github/workflows/tag-and-release.yml)

    - todo: it is not ideal that pip version and tag is different...

- making a test release using version on branch `release*`

  [build.yml](.github/workflows/build-test-release.yml) and

  [release.yml](.github/workflows/upload-to-pypi.yml) and publishing it

  to https://test.pypi.org/project/actionlint-py/#history

    - test version is set to `python -m "_custom_build" --version` + `.devN` (development version is updated

      automatically when PR is created)

- making a public release using version _custom_build/VERSION_ACTIONLINT.txt

  [build.yml](.github/workflows/build-test-release.yml) and

  [release.yml](.github/workflows/upload-to-pypi.yml) and publishing it

  to https://pypi.org/project/actionlint-py/

    - public version is set to `python -m "_custom_build" --version`

- after `release*` branch is merged development version is reset to 0

  [version-dev.yml](.github/workflows/version-dev-reset.yml)

- after `release*` branch is merged build system version is incremented

  [version-build-system.yml](.github/workflows/version-build-system.yml)

- todo: those workflow means I can not write protect main branch...

## Use actionlint from test mirror

Specify precise version of use `--pre`, or both :)

```shell

pip install --index-url https://test.pypi.org/simple/ --extra-index-url https://pypi.org/simple/ --pre actionlint-py==1.6.25.3.dev6

```

# Change actionlint version

All details about actionlint source (and checksums) are stored in [setup.cfg](setup.cfg).

The script [setup_auto_update.py](setup_auto_update.py) scraps the release page of actionlint and sets the checksums to

the newest release. It is not great quality script, but it works. Just run:

```shell

python auto_update_main.py

```

# Manual release

https://test.pypi.org/manage/project/actionlint-py/releases/

https://pypi.org/manage/project/actionlint-py/releases/

Install dependencies:

```shell

pip install --upgrade build twine

```

Build and check:

```shell

# python .\setup.py sdist bdist_wheel # deprecated

# python -c "from setuptools import setup; setup()" build # deprecated

python -m build

python -m twine check .\dist\*

```

If using token, create file `.pypirc`:

```

[pypi]

username = __token__

password = 

```

Provide file or insert creds when prompted:

```shell

python -m twine upload .\dist\* # --config-file .pypirc

```