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

fix(resources): modify names to match template-formula's #120

Merged
merged 1 commit into from
Mar 15, 2021

Conversation

javierbertoli
Copy link
Member

PR progress checklist (to be filled in by reviewers)

  • Changes to documentation are appropriate (or tick if not required)
  • Changes to tests are appropriate (or tick if not required)
  • Reviews completed

What type of PR is this?

Primary type

  • [build] Changes related to the build system
  • [chore] Changes to the build process or auxiliary tools and libraries such as documentation generation
  • [ci] Changes to the continuous integration configuration
  • [feat] A new feature
  • [fix] A bug fix
  • [perf] A code change that improves performance
  • [refactor] A code change that neither fixes a bug nor adds a feature
  • [revert] A change used to revert a previous commit
  • [style] Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc.)

Secondary type

  • [docs] Documentation changes
  • [test] Adding missing or correcting existing tests

Does this PR introduce a BREAKING CHANGE?

No, but will break dependencies to this formula resources's IDs being used in other formulas.

Related issues and/or pull requests

Should fix #119

Describe the changes you're proposing

Modified the resources IDs in the state files to follow the pattern proposed in the template-formula

Pillar / config required to test the proposed changes

Debug log showing how the proposed changes work

Documentation checklist

  • Updated the README (e.g. Available states).
  • Updated pillar.example.

Testing checklist

  • Included in Kitchen (i.e. under state_top).
  • Covered by new/existing tests (e.g. InSpec, Serverspec, etc.).
  • Updated the relevant test pillar.

Additional context

Copy link
Contributor

@baby-gnu baby-gnu left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Does this PR introduce a BREAKING CHANGE?

No, but will break dependencies to this formula resources's IDs being used in other formulas.

I think this would be considered a BREAKING CHANGE to be sure users would notice the change and adapt their own SLS if required.

Thanks.

@javierbertoli
Copy link
Member Author

@baby-gnu I agree, modified the message.

I just was not sure if external dependencies on this formula (while the formula's functionality remained the same), was a reason enough to mark it as a BREAKING CHANGE.

But I noticed we did the same in the template-formula so makes sense to mark it as such. 😋

@myii
Copy link
Member

myii commented Mar 15, 2021

@javierbertoli The tests aren't running because pre-commit is failing (due to a salt-lint violation):

Please amend the commit to fix that, so that the CI continues to work.


However, I've manually started all of the jobs and the good news is that they're passing:


@baby-gnu I agree, modified the message.

I agree with the BREAKING CHANGE, so thank you for adding that. I've run a search for formulas which potentially may be affected by this change. These are all of the formulas mentioning postfix that aren't in this formula itself:

It would be worth glancing over that list to see if there is anything obvious that would need to be fixed.


In terms of merging, we have a codeowner defined for this formula, so let's give @fzipi a chance to review this PR.

Thanks for finding the issue and supplying a prompt fix!

Copy link
Member

@myii myii left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just the salt-lint violation, AFAICT -- thanks.

The new format match the format proposed in the template-formula

BREAKING CHANGE: as all resources' IDs changed, other formulas
depending on this formula's resources will need to be modified
accordingly.
@fzipi
Copy link
Collaborator

fzipi commented Mar 15, 2021

LGTM (other that fixing the lint problem). Do you think we should clarify somewhere the naming format used from now on?

Copy link
Collaborator

@fzipi fzipi left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM.

@myii myii merged commit dc986f0 into saltstack-formulas:master Mar 15, 2021
@myii
Copy link
Member

myii commented Mar 15, 2021

@javierbertoli Merged. Thanks for the reviews, @baby-gnu @fzipi.

... Do you think we should clarify somewhere the naming format used from now on?

@javierbertoli What do you think about this issue? Cover it in another PR?

@saltstack-formulas-travis

🎉 This PR is included in version 2.0.0 🎉

The release is available on GitHub release

Your semantic-release bot 📦🚀

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[BUG] resources IDs are not unique and collide with other formulas
5 participants