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.

Sign up for GitHub

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

Jump to bottom

feat(yaml): autofix GitHub Workflow files #437

Merged
merged 39 commits into from
Jan 13, 2022
Merged

feat(yaml): autofix GitHub Workflow files #437

merged 39 commits into from
Jan 13, 2022

Conversation

andreoliwa
Copy link
Owner

@andreoliwa andreoliwa commented Jan 8, 2022 •
edited
Loading

Fixes #15.

Proposed changes

  • Test some GitHub workflow file with some real use case
    • Certain steps should exist
    • Steps content should be changed if different
  • Use "name" as unique key
  • The user can change the unique key by setting the dunder value on the style file
  • Document this usage on .rst
  • This comment will be already covered when GitHub Workflows are added to the mix: 
    # FIXME: test adding list keys to some other file with a list of objects
["an/arbitrary/file.yaml".__list_keys]
my.list.with.dicts = "name"

Checklist

  • Read the contribution guidelines
  • Run make locally before pushing commits
  • Add tests for the relevant parts:
    • API
    • CLI
    • flake8 plugin (normal mode)
    • flake8 plugin (offline mode)
  • Write documentation when there's a new API or functionality

@coveralls
Copy link

coveralls commented Jan 8, 2022 •
edited
Loading

Pull Request Test Coverage Report for Build 1690855501

  • 211 of 213 (99.06%) changed or added relevant lines in 8 files are covered.
  • 1 unchanged line in 1 file lost coverage.
  • Overall coverage increased (+0.2%) to 97.034%
Changes Missing Coverage Covered Lines Changed/Added Lines %
src/nitpick/blender.py 163 165 98.79%
Files with Coverage Reduction New Missed Lines %
src/nitpick/blender.py 1 96.73%
Totals Coverage Status
Change from base Build 1690497299: 0.2%
Covered Lines: 2002
Relevant Lines: 2046
💛 - Coveralls

@andreoliwa
test: list of scalars: change/add elements starting from index 0
a63ab6a 
Keep remaining items if they exist
@andreoliwa
refactor: use pydantic models for list details
a22ace1
@andreoliwa
refactor: compare_list_elements()
f92951b
@andreoliwa
refactor: rename to element_key, write comments
5b4e168
@andreoliwa
chore: fix mypy
5601569
@andreoliwa
refactor: join parent and nested keys again
e16bc72
@andreoliwa
refactor: deal with empty JMES expression
eb7337a
@andreoliwa
refactor: replace or add a new element in a YAML list
172f3b3
@andreoliwa
refactor: remove unnecessary constants for classes
22dba62
@andreoliwa
refactor: remove unused if condition
457cf1c
@andreoliwa
refactor: remove unused ValueError
f838001
@andreoliwa
chore: some tomlkit classes and their representation on ruamel.yaml
8f04698
@andreoliwa
refactor: remove unused code
decf76d
@andreoliwa
docs: next change
ea55cf8
@andreoliwa
refactor: Comparison class
73cbe4d
@andreoliwa
refactor: move compare_list_elements() to Comparison class
75f00f2
@andreoliwa
refactor: extract _compare_children()
cd3e944
@andreoliwa
refactor: typing and moving a chunk out
ea1b486
@andreoliwa
feat: list of dicts: compare elements by hash when there's no key
b9d3a91
@andreoliwa
refactor: rename again to __list_keys
5b1a923
@andreoliwa
docs: add special configuration section
72d11ec
@andreoliwa
test: objects are compared by hash and new ones are added
838abf4
@andreoliwa
test: maximum of two-level nesting on lists
0a0fcae
@andreoliwa
refactor: back to the simple syntax parent_key.child_key
c9a2336
@andreoliwa
ci: change UTF-8 failing on Windows
1b81999
@andreoliwa
ci: UTF-8 still failing on Windows; remove umlaut
df74aec
@andreoliwa andreoliwa marked this pull request as ready for review January 13, 2022 02:40
@andreoliwa andreoliwa enabled auto-merge (squash) January 13, 2022 03:11
@andreoliwa andreoliwa merged commit 6af77c4 into develop Jan 13, 2022
@andreoliwa andreoliwa deleted the test-github-workflows branch January 13, 2022 03:12
github-actions bot pushed a commit that referenced this pull request Jan 14, 2022
@semantic-release-bot
chore(release): 0.30.0 [skip ci]
8a1d2bd 
# [0.30.0](v0.29.0...v0.30.0) (2022-01-14)

### Bug Fixes

* style override on Windows ([#422](#422)) ([e7d2897](e7d2897))
* use current dir; don't climb dirs to find the project root ([#421](#421)) ([3c82e8c](3c82e8c))

### Features

* default pre-commit hook now runs "nitpick fix" ([cb4c242](cb4c242))
* **json:** autofix JSON files ([#429](#429)) ([4b58a03](4b58a03))
* nitpick init adds a [tool.nitpick] section ([36f4065](36f4065))
* **yaml:** autofix .pre-commit-config.yaml (note: style changed!) ([#434](#434)) ([352b53d](352b53d))
* **yaml:** autofix GitHub Workflow files ([#437](#437)) ([6af77c4](6af77c4))
* **yaml:** autofix YAML files ([#431](#431)) ([d8cc4b1](d8cc4b1))
@github-actions
Copy link

🎉 This PR is included in version 0.30.0 🎉

The release is available on:

Your semantic-release bot 📦🚀

@github-actions github-actions bot added the released Feature/fix is released label Jan 14, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
released Feature/fix is released
Projects
Nitpick Roadmap
Archived in project
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Check .travis.yml
2 participants
@andreoliwa @coveralls