Skip to content

Commit

Permalink
Merge pull request #115 from CPS-IT/task/drop-identifier
Browse files Browse the repository at this point in the history
[!!!][TASK] Drop deprecated `identifier` property
  • Loading branch information
eliashaeussler committed Feb 22, 2023
2 parents b7ff936 + ed6f33f commit 4329a0d
Show file tree
Hide file tree
Showing 2 changed files with 0 additions and 10 deletions.
4 changes: 0 additions & 4 deletions docs/development/configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -135,8 +135,6 @@ for an overview of supported filenames.

Each config file should at least contain the following properties:

* **`identifier`** describes the project type. It is used internally to handle
project generation while processing the required build steps.
* **`name`** is kind of a label for the configured project type. It is mainly
used for communication with the user, keeping the actual project type internal.
* **`steps`** defines a list of necessary build steps. Those steps are processed
Expand All @@ -155,7 +153,6 @@ Example:
:linenos:
:caption: config.yaml
identifier: my-fancy-project
name: My fancy project
steps:
Expand Down Expand Up @@ -225,7 +222,6 @@ Each configured property in the config file is now accessible from the

| Property | Accessor | Type |
|--------------|----------------------------|------------------------------------------------------------------------------------------------------------------------------------------------|
| `identifier` | `$config->getIdentifier()` | `string` |
| `name` | `$config->getName()` | `string` |
| `steps` | `$config->getSteps()` | [`list<Builder\Config\ValueObject\Step>`](https://github.com/CPS-IT/project-builder/blob/main/src/Builder/Config/ValueObject/Step.php) |
| `properties` | `$config->getProperties()` | [`list<Builder\Config\ValueObject\Property>`](https://github.com/CPS-IT/project-builder/blob/main/src/Builder/Config/ValueObject/Property.php) |
Expand Down
6 changes: 0 additions & 6 deletions resources/config.schema.json
Original file line number Diff line number Diff line change
Expand Up @@ -3,12 +3,6 @@
"type": "object",
"title": "Project builder template configuration",
"properties": {
"identifier": {
"type": "string",
"title": "Project template identifier",
"description": "No longer needed, templates are now identified by their Composer package name.",
"deprecated": true
},
"name": {
"type": "string",
"title": "Project template name",
Expand Down

0 comments on commit 4329a0d

Please sign in to comment.