Skip to content

Commit

Permalink
Scope name to HCL actions
Browse files Browse the repository at this point in the history
  • Loading branch information
bbckr committed Sep 18, 2024
1 parent f775167 commit 116d4b0
Show file tree
Hide file tree
Showing 10 changed files with 7 additions and 9 deletions.
Original file line number Diff line number Diff line change
@@ -1,14 +1,14 @@
# scaffolder-backend-module-actions
# hcl-scaffolder-actions-backend

Welcome to the scaffolder-backend-module-actions plugin!
This contains a collection of actions to use in scaffolder templates for working with HCL (Hashicorp Configuration Language). See https://github.com/hashicorp/hcl to learn more about HCL.

## Getting started

### From your Backstage root directory

```bash
# From your Backstage root directory
yarn add --cwd packages/backend @seatgeek/backstage-plugin-scaffolder-actions-backend
yarn add --cwd packages/backend @seatgeek/backstage-plugin-hcl-scaffolder-actions-backend
```

Then ensure that both the scaffolder and this module are added to your backend:
Expand All @@ -17,15 +17,13 @@ Then ensure that both the scaffolder and this module are added to your backend:
// In packages/backend/src/index.ts
const backend = createBackend();
// ...
backend.add(import('@seatgeek/backstage-plugin-scaffolder-actions-backend'));
backend.add(import('@seatgeek/backstage-plugin-hcl-scaffolder-actions-backend'));
```

After that you can use the actions in your template.

## Actions

This contains a collection of actions to use in scaffolder templates:

- `hcl:merge` Merge HCL strings
- `hcl:merge:write` Merge HCL strings and write to a file
- `hcl:merge:files` Merge HCL files
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
{
"name": "@seatgeek/backstage-plugin-scaffolder-actions-backend",
"name": "@seatgeek/backstage-plugin-hcl-scaffolder-actions-backend",
"version": "0.0.0-semantically-released",
"main": "src/index.ts",
"types": "src/index.ts",
Expand All @@ -13,7 +13,7 @@
"role": "backend-plugin-module",
"pluginId": "scaffolder",
"pluginPackages": [
"@seatgeek/backstage-plugin-scaffolder-actions-backend"
"@seatgeek/backstage-plugin-hcl-scaffolder-actions-backend"
],
"pluginPackage": "@backstage/plugin-scaffolder-backend"
},
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ import * as actions from './actions';

export const scaffolderBackendModuleActions = createBackendModule({
pluginId: 'scaffolder',
moduleId: 'seatgeek-scaffolder-actions-backend-module',
moduleId: 'hcl-scaffolder-actions-backend-module',
register({ registerInit }) {
registerInit({
deps: {
Expand Down

0 comments on commit 116d4b0

Please sign in to comment.