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

Module packages #582

Merged
merged 16 commits into from
Nov 12, 2024
Merged

Module packages #582

merged 16 commits into from
Nov 12, 2024

Conversation

ericzbeard
Copy link
Contributor

@ericzbeard ericzbeard commented Nov 5, 2024

This PR adds package aliases to the Rain section, allowing module URIs to be aliased. It also adds the capability to unzip a directory of modules and verify a hash.

Rain:
  Packages:
    aws:
      Location: https://github.com/aws-cloudformation/rain/modules
    xyz:
      Location: ./my-modules
    abc:
      Location: https://github.com/aws-cloudformation/rain/releases/tag/m0.1.0/modules.zip
      Hash: https://github.com/aws-cloudformation/rain/releases/tag/m0.1.0/modules.sha256

Resources:
  Foo:
    Type: !Rain::Module aws/foo.yaml

  Bar:
    Type: !Rain::Module xyz/bar.yaml

  Baz:
    Type: $abc/baz.yaml
    # Shorthand for !Rain::Module abc/baz.yaml

Modules from the test directory were moved to the top level and will be released separately with their own version number. This allows the package to be referenced by tags, such as m0.1.0 as shown in the example above. The major version number will be incremented if any breaking changes are introduced to the modules. The available modules in the release package are listed below.

This PR also adds a few other features, like putting Constants in modules, and conditionally emitting resources in modules with the IfParam Rain Metadata attribute.

@ericzbeard ericzbeard marked this pull request as ready for review November 8, 2024 22:07
@ericzbeard ericzbeard merged commit f020e02 into aws-cloudformation:main Nov 12, 2024
1 check passed
@ericzbeard ericzbeard deleted the packages branch November 12, 2024 17:31
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant