Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Groom generated YAMLs #135

Open
oesgalha opened this issue Dec 30, 2021 · 0 comments
Open

Groom generated YAMLs #135

oesgalha opened this issue Dec 30, 2021 · 0 comments
Labels
A: CI Template Area: builtin continuous integration pipeline templates good first issue Good First Issue T: Enhancement Type: an enhancement to an existing feature

Comments

@oesgalha
Copy link
Collaborator

Context

Pipelinit currently has 25 YAML templates to generate CI pipelines, bu they were built without enforcing a code format. We should make sure the templates and generated output follows the Prettier format. Also, some files use .yml and others the .yaml extension.

Finally, the generated files may contain blank lines, that we could trim:

      - run: python -m pip install pipenv; pipenv install --dev

      - run: python -m pip install pip flake8
      - run: python -m pip install pip bandit

      # Adapts Flake8 to run with the Black formatter, using the '--ignore' flag to skip incompatibilities errors
      # Reference: https://black.readthedocs.io/en/stable/guides/using_black_with_other_tools.html?highlight=other%20tools#id1
      - run: pipenv run flake8 --ignore E203,E501,W503 .
      - run: pipenv run bandit -r .

Goal

  • Make sure every template and generated output is formatted with the latest Prettier
  • Standardize with .yaml for file extensions1
  • Remove blank lines from generated output

This could be implemented after #129 to keep it enforced

Footnotes

  1. https://yaml.org/faq.html

@oesgalha oesgalha added A: CI Template Area: builtin continuous integration pipeline templates T: Enhancement Type: an enhancement to an existing feature good first issue Good First Issue labels Dec 30, 2021
@lilianeconstantino lilianeconstantino self-assigned this Mar 2, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
A: CI Template Area: builtin continuous integration pipeline templates good first issue Good First Issue T: Enhancement Type: an enhancement to an existing feature
Projects
None yet
Development

No branches or pull requests

2 participants