refac(back): fluidattacks#1351 simplify builtin name

- Rename from deployContainerImage to deployContainer Signed-off-by: Daniel Salazar <podany270895@gmail.com>
dsalaza4 · Jul 26, 2024 · fb94869 · fb94869
1 parent 4e2e7ab
commit fb94869
Show file tree

Hide file tree

Showing 5 changed files with 21 additions and 21 deletions.
diff --git a/.github/workflows/prod.yml b/.github/workflows/prod.yml
@@ -2,7 +2,7 @@ concurrency:
  cancel-in-progress: true
  group: ${{ github.actor }}
 jobs:
- deployContainerImage_makesLatestAmd64:
+ deployContainer_makesLatestAmd64:
  if: ${{ github.repository == 'fluidattacks/makes' }}
  runs-on: ubuntu-latest
  permissions:
@@ -15,8 +15,8 @@ jobs:
  GITHUB_ACTOR: ${{ github.actor }}
  GITHUB_TOKEN: ${{ github.token }}
  with:
- args: sh -c "chown -R root:root /github/workspace && nix-env -if . && m . /deployContainerImage/makesLatestAmd64"
- deployContainerImage_makesLatestArm64:
+ args: sh -c "chown -R root:root /github/workspace && nix-env -if . && m . /deployContainer/makesLatestAmd64"
+ deployContainer_makesLatestArm64:
  if: ${{ github.repository == 'fluidattacks/makes' }}
  runs-on: buildjet-2vcpu-ubuntu-2204-arm
  permissions:
@@ -29,8 +29,8 @@ jobs:
  GITHUB_ACTOR: ${{ github.actor }}
  GITHUB_TOKEN: ${{ github.token }}
  with:
- args: sh -c "chown -R root:root /github/workspace && nix-env -if . && m . /deployContainerImage/makesLatestArm64"
- deployContainerImage_makesPinnedAmd64:
+ args: sh -c "chown -R root:root /github/workspace && nix-env -if . && m . /deployContainer/makesLatestArm64"
+ deployContainer_makesPinnedAmd64:
  if: ${{ github.repository == 'fluidattacks/makes' }}
  runs-on: ubuntu-latest
  permissions:
@@ -43,8 +43,8 @@ jobs:
  GITHUB_ACTOR: ${{ github.actor }}
  GITHUB_TOKEN: ${{ github.token }}
  with:
- args: sh -c "chown -R root:root /github/workspace && nix-env -if . && m . /deployContainerImage/makesPinnedAmd64"
- deployContainerImage_makesPinnedArm64:
+ args: sh -c "chown -R root:root /github/workspace && nix-env -if . && m . /deployContainer/makesPinnedAmd64"
+ deployContainer_makesPinnedArm64:
  if: ${{ github.repository == 'fluidattacks/makes' }}
  runs-on: buildjet-2vcpu-ubuntu-2204-arm
  permissions:
@@ -57,7 +57,7 @@ jobs:
  GITHUB_ACTOR: ${{ github.actor }}
  GITHUB_TOKEN: ${{ github.token }}
  with:
- args: sh -c "chown -R root:root /github/workspace && nix-env -if . && m . /deployContainerImage/makesPinnedArm64"
+ args: sh -c "chown -R root:root /github/workspace && nix-env -if . && m . /deployContainer/makesPinnedArm64"
  releaseGitHub:
  if: ${{ github.repository == 'fluidattacks/makes' }}
  runs-on: ubuntu-latest

diff --git a/docs/src/api/builtins/deploy.md b/docs/src/api/builtins/deploy.md
@@ -132,7 +132,7 @@ Note that positional arguments (`[ "1" "2" "3" ]` in this case)
 will be appended to the end of `command`
 before sending the job to Batch.
 
-## deployContainerImage
+## deployContainer
 
 Deploy a set of container images
 in [OCI Format](https://github.com/opencontainers/image-spec)
@@ -143,7 +143,7 @@ please read the `makeContainerImage` reference.
 
 Types:
 
-- deployContainerImage:
+- deployContainer:
  - images (`attrsOf imageType`): Optional.
  Definitions of container images to deploy.
  Defaults to `{ }`.
@@ -195,7 +195,7 @@ Example:
   };
   };
 
-  deployContainerImage = {
+  deployContainer = {
   images = {
   nginxDockerHub = {
   credentials = {
@@ -235,19 +235,19 @@ Example:
 === "Invocation DockerHub"
 
  ```bash
- DOCKER_HUB_USER=user DOCKER_HUB_PASS=123 m . /deployContainerImage/nginxDockerHub
+ DOCKER_HUB_USER=user DOCKER_HUB_PASS=123 m . /deployContainer/nginxDockerHub
  ```
 
 === "Invocation GitHub"
 
  ```bash
- GITHUB_ACTOR=user GITHUB_TOKEN=123 m . /deployContainerImage/makesLatest
+ GITHUB_ACTOR=user GITHUB_TOKEN=123 m . /deployContainer/makesLatest
  ```
 
 === "Invocation GitLab"
 
  ```bash
- CI_REGISTRY_USER=user CI_REGISTRY_PASSWORD=123 m . /deployContainerImage/makesGitLab
+ CI_REGISTRY_USER=user CI_REGISTRY_PASSWORD=123 m . /deployContainer/makesGitLab
  ```
 
 ## deployTerraform

diff --git a/makes.nix b/makes.nix
@@ -18,7 +18,7 @@
  enable = true;
  target = "github.com/fluidattacks/makes";
  };
- deployContainerImage = {
+ deployContainer = {
  images = {
  makesLatestAmd64 = {
  attempts = 3;

diff --git a/src/args/agnostic.nix b/src/args/agnostic.nix
@@ -30,7 +30,7 @@ let
  calculateScorecard = import ./calculate-scorecard/default.nix self;
  chunks = import ./chunks/default.nix self;
  computeOnAwsBatch = import ./compute-on-aws-batch/default.nix self;
- deployContainerImage = import ./deploy-container-image/default.nix self;
+ deployContainer = import ./deploy-container-image/default.nix self;
  deployNomad = import ./deploy-nomad/default.nix self;
  deployTerraform = import ./deploy-terraform/default.nix self;
  inherit (__nixpkgs__.lib.strings) escapeShellArg;

diff --git a/src/evaluator/modules/deploy-container-image/default.nix b/src/evaluator/modules/deploy-container-image/default.nix
@@ -1,9 +1,9 @@
-{ __toModuleOutputs__, deployContainerImage, ... }:
+{ __toModuleOutputs__, deployContainer, ... }:
 { config, lib, ... }:
 let
  makeOutput = name: args: {
- name = "/deployContainerImage/${name}";
- value = deployContainerImage {
+ name = "/deployContainer/${name}";
+ value = deployContainer {
  inherit (args) attempts;
  inherit (args) credentials;
  containerImage = args.src;
@@ -16,7 +16,7 @@ let
  };
 in {
  options = {
- deployContainerImage = {
+ deployContainer = {
  images = lib.mkOption {
  default = { };
  type = lib.types.attrsOf (lib.types.submodule (_: {
@@ -46,6 +46,6 @@ in {
  };
  };
  config = {
- outputs = __toModuleOutputs__ makeOutput config.deployContainerImage.images;
+ outputs = __toModuleOutputs__ makeOutput config.deployContainer.images;
  };
 }