saltstack-formulas / iscsi-formula

Manage iSCSI Target and Initiator via SaltStack (FreeBSD & GNU/Linux)
http://docs.saltstack.com/en/latest/topics/development/conventions/formulas.html
Other
8 stars 7 forks source link

feat(semantic-release): complete for this formula #30

Closed myii closed 4 years ago

myii commented 4 years ago

@noelmcloughlin This PR brings the implementation into line with the latest structure across semantic-release formulas. In includes:

  1. The new method of working with Travis, as introduced in https://github.com/saltstack-formulas/template-formula/pull/175.
  2. Lint errors corrected for both of the new linters introduced (salt-lint and rubocop).
  3. Other minor issues with documentation and standard structures.

One thing I noticed that I didn't get time to resolve is the missing tofs block in pillar.example. Something like:

  tofs:
    # The files_switch key serves as a selector for alternative
    # directories under the formula files directory. See TOFS pattern
    # doc for more info.
    # Note: Any value not evaluated by `config.get` will be used literally.
    # This can be used to set custom paths, as many levels deep as required.
    # files_switch:
    #   - any/path/can/be/used/here
    #   - id
    #   - roles
    #   - osfinger
    #   - os
    #   - os_family
    # All aspects of path/file resolution are customisable using the options below.
    # This is unnecessary in most cases; there are sensible defaults.
    # Default path: salt://< path_prefix >/< dirs.files >/< dirs.default >
    #         I.e.: salt://template/files/default
    # path_prefix: template_alt
    # dirs:
    #   files: files_alt
    #   default: default_alt
    # The entries under `source_files` are prepended to the default source files
    # given for the state
    source_files:
      template-config-file-file-managed:
        - 'example_alt.tmpl'
        - 'example_alt.tmpl.jinja'

The source_files would need to be updated for all uses of files_switch throughout this formula. Since you're the most familiar with that, I'll leave that in your capable hands.

saltstack-formulas-travis commented 4 years ago

:tada: This PR is included in version 1.1.0 :tada:

The release is available on GitHub release

Your semantic-release bot :package::rocket: