Skip to content
This repository has been archived by the owner on Feb 16, 2024. It is now read-only.

Commit

Permalink
added netlify sdk 0.8.5 docs (#364)
Browse files Browse the repository at this point in the history
* added netlify sdk 0.8.5 docs

* run prettier
  • Loading branch information
mohab-sameh authored Sep 20, 2023
1 parent 99b6c38 commit 28af725
Show file tree
Hide file tree
Showing 8 changed files with 403 additions and 67 deletions.
58 changes: 50 additions & 8 deletions netlify-sdk/0.8.5/createEnvironmentVariable/README.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,54 @@
This codemod changes createEnvironmentVariable to pass an object instead of the separate arguments:
# createEnvironmentVariable

createEnvironmentVariable(accountId, siteId, key, values)
## Description

to
This codemod changes `createEnvironmentVariable` to pass an object instead of the separate arguments as required in Netlify SDK v0.8.5.

## Example

### Before

```jsx
createEnvironmentVariable(accountId, siteId, key, values);
```

### After

```jsx
createEnvironmentVariable({
accountId: accountId,
siteId: siteId,
key: key,
values: values
})
accountId: accountId,
siteId: siteId,
key: key,
values: values,
});
```

## Applicability Criteria

Netlify SDK v0.8.5 or higher.

## Other Metadata

### Codemod Version

v1.0.0

### Change Mode

**Autonomous**: Changes can safely be pushed and merged without further human involvement.

### **Codemod Engine**

jscodeshift

### Estimated Time Saving

~3 minutes per occurrence

### Owner

[Intuita](https://github.com/intuita-inc)

### Links for more info

- [Netlify SDK v0.8.5 Release Notes](https://sdk.netlify.com/release-notes/#085)
58 changes: 50 additions & 8 deletions netlify-sdk/0.8.5/createOrUpdateVariable/README.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,54 @@
This codemod changes createOrUpdateVariable to pass an object instead of the separate arguments:
# createOrUpdateVariable

createOrUpdateVariable(accountId, siteId, key, value)
## Description

to
This codemod changes `createOrUpdateVariable` to pass an object instead of the separate arguments as required in Netlify SDK v0.8.5.

## Example

### Before

```jsx
createOrUpdateVariable(accountId, siteId, key, value);
```

### After

```jsx
createOrUpdateVariable({
accountId: accountId,
siteId: siteId,
key: key,
values: value
})
accountId: accountId,
siteId: siteId,
key: key,
values: value,
});
```

## Applicability Criteria

Netlify SDK v0.8.5 or higher.

## Other Metadata

### Codemod Version

v1.0.0

### Change Mode

**Autonomous**: Changes can safely be pushed and merged without further human involvement.

### **Codemod Engine**

jscodeshift

### Estimated Time Saving

~3 minutes per occurrence

### Owner

[Intuita](https://github.com/intuita-inc)

### Links for more info

- [Netlify SDK v0.8.5 Release Notes](https://sdk.netlify.com/release-notes/#085)
56 changes: 49 additions & 7 deletions netlify-sdk/0.8.5/createOrUpdateVariables/README.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,53 @@
This codemod changes createOrUpdateVariables to pass an object instead of the separate arguments:
# createOrUpdateVariables

createOrUpdateVariables(accountId, siteId, variables)
## Description

to
This codemod changes `createOrUpdateVariables` to pass an object instead of the separate arguments as required in Netlify SDK v0.8.5.

## Example

### Before

```jsx
createOrUpdateVariables(accountId, siteId, variables);
```

### After

```jsx
createOrUpdateVariables({
accountId: accountId,
siteId: siteId,
key: variables
})
accountId: accountId,
siteId: siteId,
key: variables,
});
```

## Applicability Criteria

Netlify SDK v0.8.5 or higher.

## Other Metadata

### Codemod Version

v1.0.0

### Change Mode

**Autonomous**: Changes can safely be pushed and merged without further human involvement.

### **Codemod Engine**

jscodeshift

### Estimated Time Saving

~3 minutes per occurrence

### Owner

[Intuita](https://github.com/intuita-inc)

### Links for more info

- [Netlify SDK v0.8.5 Release Notes](https://sdk.netlify.com/release-notes/#085)
56 changes: 49 additions & 7 deletions netlify-sdk/0.8.5/deleteEnvironmentVariable/README.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,53 @@
This codemod changes deleteEnvironmentVariable to pass an object instead of the separate arguments:
# deleteEnvironmentVariable

deleteEnvironmentVariable(accountId, siteId, key)
## Description

to
This codemod changes `deleteEnvironmentVariable` to pass an object instead of the separate arguments as required in Netlify SDK v0.8.5.

## Example

### Before

```jsx
deleteEnvironmentVariable(accountId, siteId, key);
```

### After

```jsx
deleteEnvironmentVariable({
accountId: accountId,
siteId: siteId,
key: key
})
accountId: accountId,
siteId: siteId,
key: key,
});
```

## Applicability Criteria

Netlify SDK v0.8.5 or higher.

## Other Metadata

### Codemod Version

v1.0.0

### Change Mode

**Autonomous**: Changes can safely be pushed and merged without further human involvement.

### **Codemod Engine**

jscodeshift

### Estimated Time Saving

~3 minutes per occurrence

### Owner

[Intuita](https://github.com/intuita-inc)

### Links for more info

- [Netlify SDK v0.8.5 Release Notes](https://sdk.netlify.com/release-notes/#085)
56 changes: 49 additions & 7 deletions netlify-sdk/0.8.5/deleteEnvironmentVariables/README.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,53 @@
This codemod changes deleteEnvironmentVariables to pass an object instead of the separate arguments:
# deleteEnvironmentVariables

deleteEnvironmentVariables(accountId, siteId, variables)
## Description

to
This codemod changes `deleteEnvironmentVariables` to pass an object instead of the separate arguments as required in Netlify SDK v0.8.5.

## Example

### Before

```jsx
deleteEnvironmentVariables(accountId, siteId, variables);
```

### After

```jsx
deleteEnvironmentVariables({
accountId: accountId,
siteId: siteId,
variables: variables
})
accountId: accountId,
siteId: siteId,
variables: variables,
});
```

## Applicability Criteria

Netlify SDK v0.8.5 or higher.

## Other Metadata

### Codemod Version

v1.0.0

### Change Mode

**Autonomous**: Changes can safely be pushed and merged without further human involvement.

### **Codemod Engine**

jscodeshift

### Estimated Time Saving

~3 minutes per occurrence

### Owner

[Intuita](https://github.com/intuita-inc)

### Links for more info

- [Netlify SDK v0.8.5 Release Notes](https://sdk.netlify.com/release-notes/#085)
54 changes: 48 additions & 6 deletions netlify-sdk/0.8.5/getEnvironmentVariables/README.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,52 @@
This codemod changes getEnvironmentVariables to pass an object instead of the separate arguments:
# getEnvironmentVariables

getEnvironmentVariables(accountId, siteId)
## Description

to
This codemod changes `getEnvironmentVariables` to pass an object instead of the separate arguments as required in Netlify SDK v0.8.5.

## Example

### Before

```jsx
getEnvironmentVariables(accountId, siteId);
```

### After

```jsx
getEnvironmentVariables({
accountId: accountId,
siteId: siteId
})
accountId: accountId,
siteId: siteId,
});
```

## Applicability Criteria

Netlify SDK v0.8.5 or higher.

## Other Metadata

### Codemod Version

v1.0.0

### Change Mode

**Autonomous**: Changes can safely be pushed and merged without further human involvement.

### **Codemod Engine**

jscodeshift

### Estimated Time Saving

~3 minutes per occurrence

### Owner

[Intuita](https://github.com/intuita-inc)

### Links for more info

- [Netlify SDK v0.8.5 Release Notes](https://sdk.netlify.com/release-notes/#085)
Loading

0 comments on commit 28af725

Please sign in to comment.