Skip to content

Commit

Permalink
Use sub-bullets instead for change notice
Browse files Browse the repository at this point in the history
  • Loading branch information
pearofducks committed Feb 11, 2018
1 parent 2e0f62d commit aa34a39
Showing 1 changed file with 5 additions and 3 deletions.
8 changes: 5 additions & 3 deletions README.md
@@ -1,13 +1,15 @@
## upcoming breaking changes
## upcoming changes in v2

Near the end of March 2018, this plugin will update to v2 and will have a few minor breaking changes. This branch can be previewed at `v2` and should be stable.

1. The filetype for playbooks will be set to `yaml.ansible`.
- The filetype for playbooks will be set to `yaml.ansible`.
- Using a compound filetype here improves compatibility with some other plugins, and is a bit more honest about the filetypes being used. We _could_ set it to `yaml.jinja2.ansible`, if there are strong opinions on this please open an issue.
- This _only_ breaks setups using vim plugin on-demand loading features — e.g. `{ 'for': 'ansible' }` in vim-plug. Otherwise this change should not break anything.
2. `g:ansible_extra_syntaxes` will be deprecated in favor of `g:ansible_template_syntaxes` — which will use conditional compound filetypes, instead of sourcing all filetypes listed and hiding them under `ansible_template`.
- `g:ansible_extra_syntaxes` will be deprecated in favor of `g:ansible_template_syntaxes` — which will use conditional compound filetypes, instead of sourcing all filetypes listed and hiding them under `ansible_template`.
- While this is a complete deprecation of one setting, the new functionality is significantly better all around and should support the same use-cases.
- Example: a ruby+ansible-template will have a filetype of `ruby.jinja2` instead of `ansible_template`

One non-breaking change will also be added, this plugin will gain additional compatibility with _stephpy/vim-yaml_ — syntax highlights will be improved when using this plugin.

## introduction

Expand Down

0 comments on commit aa34a39

Please sign in to comment.