Skip to content

Utilities

Utilities provide an easy mechanism for calling functions from makes without having to specify them on any file.

makeNodeJsLock

You can generate a package-lock.json for makeNodeJsEnvironment like this:

1
2
3
4
m github:fluidattacks/makes@24.02 /utils/makeNodeJsLock \
  "${node_js_version}" \
  "${package_json_dir}" \
  "${lockfile_version}"
  • Supported node_js_versions are: 18, 20 and 21.
  • package_json_dir is the absolute path to the directory that contains the package.json file in your project.
  • The package-lock.json file will be generated in the same directory that contains the package.json file.
  • The lockfile_version is an optional argument, defaults to 2 and can be 1 or 2.

makePythonLock

You can generate a poetry.lock for makePythonEnvironment like this:

1
2
3
m github:fluidattacks/makes@24.02 /utils/makePythonLock \
  "${python_version}" \
  "${project}"
  • Supported python_versions are 3.9, 3.10, 3.11 and 3.12

  • project is the absolute path to a Python project containing a pyproject.toml file. Example:

     1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
    [tool.poetry]
name = "test"
version = "0.1.0"
description = ""
authors = ["Your Name <you@example.com>"]
readme = "README.md"

[tool.poetry.dependencies]
python = "^3.11"
Django = "3.2.0"
psycopg2 = "2.9.1"


[build-system]
requires = ["poetry-core"]
build-backend = "poetry.core.masonry.api"

makeRubyLock

You can generate a sourcesYaml for makeRubyGemsEnvironment like this:

1
2
3
4
m github:fluidattacks/makes@24.02 /utils/makeRubyLock \
  "${ruby_version}" \
  "${dependencies_yaml}" \
  "${sources_yaml}"
  • Supported ruby_versions are: 3.1, 3.2 and 3.3.

  • dependencies_yaml is the absolute path to a YAML file mapping RubyGems gems to version constraints. Example:

    1
2
    rubocop: "1.43.0"
slim: "~> 4.1"

  • sources_yaml is the absolute path to a file were the script will output results.

makeSopsEncryptedFile

You can generate an encrypted Sops file like this:

1
2
3
m github:fluidattacks/makes@24.02 /utils/makeSopsEncryptedFile \
  "${kms_key_arn}" \
  "${output}"
  • kms_key_arn is the arn of the key you will use for encrypting the file.
  • output is the path for your resulting encrypted file.

workspaceForTerraformFromEnv

Sets a Terraform Workspace specified via environment variable.

Types:

  • workspaceForTerraformFromEnv:
    • modules (attrsOf moduleType): Optional. Terraform modules to switch workspace. Defaults to { }.
  • moduleType (submodule):
    • setup (listOf package): Optional. Makes Environment or Makes Secrets to source (as in Bash's source) before anything else. Defaults to [ ].
    • src (str): Path to the Terraform module.
    • variable (str): Optional. Name of the environment variable that contains the name of the workspace you want to use. Defaults to "". When "" provided, workspace is default.
    • version (enum [ "0.14" "0.15" "1.0" ]): Terraform version your module is built with.

Example:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
{
  testTerraform = {
    modules = {
      module1 = {
        setup = [
          outputs."/workspaceForTerraformFromEnv/module1"
        ];
        src = "/my/module1";
        version = "0.14";
      };
    };
  };
  workspaceForTerraformFromEnv = {
    modules = {
      module1 = {
        src = "/my/module1";
        variable = "CI_COMMIT_REF_NAME";
        version = "0.14";
      };
    };
  };
}