Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Save description of what was applied through the migration script #56

Open
pmbanugo opened this issue Jun 4, 2021 · 4 comments
Open
Labels
feature A feature is desirable

Comments

@pmbanugo
Copy link
Contributor

pmbanugo commented Jun 4, 2021

Currently, we store only the migration script file name as an entry after the migration is run. I think it will be a good idea to store the description of what changed with the script so that when one reads the entry, they can see what applied without going to the code.

This can be the same description of what was applied when the migration is deployed.

@n4bb12
Copy link
Contributor

n4bb12 commented Jun 7, 2021

Which "description of what changed" are you referring to?

@pmbanugo
Copy link
Contributor Author

pmbanugo commented Jun 7, 2021

When the migration is run on the CLI, it shows what types and fields will be applied. That's what I mean by description. E.g

Environment: dev

Create Content Type Copy
  - name: "_Modul Copy"
  - description: "Modul zum Darstellen eines Countdowns"
  - displayField: "title"

  Create field title
    - name: "Titel"
    - type: "Symbol"
    - required: true

  Create field text
    - name: "Präfix"
    - type: "Symbol"
    - required: false

@n4bb12
Copy link
Contributor

n4bb12 commented Jun 7, 2021

Ah, I didn't think of that.

I think it would be a great idea. However, not all migrations create one new content type. They could be

  • creating multiple new content types
  • deleting content types
  • changing fields on an existing content type
  • migrating content entries

What would be the appropriate description in those cases?

@pmbanugo
Copy link
Contributor Author

pmbanugo commented Jun 7, 2021

I will come back to you later with an answer so that it will be clear on what the descriptions for each possible actions will be, and how we can likely get those descriptions.

@marquesVF marquesVF added the feature A feature is desirable label Dec 19, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
feature A feature is desirable
Projects
None yet
Development

No branches or pull requests

3 participants