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

Define "getting started" user stories, improve APIs to support #6

Open
badgerwithagun opened this issue Jun 10, 2017 · 8 comments
Open

Comments

@badgerwithagun
Copy link
Member

Morf grew organically with Alfa Systems, so we have never actually documented how to implement it from scratch in a new project. In finalising these user stories, we will be both documenting them for new users and implementing any new APIs necessary to make the experience right.

@badgerwithagun badgerwithagun self-assigned this Jun 10, 2017
@badgerwithagun badgerwithagun added this to the 1.0.0 milestone Jun 10, 2017
@badgerwithagun
Copy link
Member Author

In progress

badgerwithagun referenced this issue in badgerwithagun/morf Oct 6, 2017
…ed without injection of Upgrade or Deployment.
@badgerwithagun
Copy link
Member Author

badgerwithagun commented Oct 20, 2017

Main issues:

  • No way of using Upgrade or Deployment without Guice (addressed partially by Partial #6: Allow upgrade/deployment without Guice #37)
  • Jira ID should be removed from Morf's UpgradeStep interface
  • Lack of functional consistency in where annotations or methods are used on UpgradeStep

@Jaffa
Copy link
Contributor

Jaffa commented Oct 26, 2017

Jira ID should be removed from Morf's UpgradeStep interface

Presumably you're imagining replacing it with an annotation? There's some niceness to having a get change id method. We could have an AbstractUpgradeStep that implemented that by reading the UUID annotation; but projects that do have overarching change control (whether github, JIRA, ...) still have a place to ensure the metadata is captured.

@badgerwithagun
Copy link
Member Author

badgerwithagun commented Oct 26, 2017

An annotation was the thinking, yes, but it'd probably not be part of Morf, unless we generalised it (e.g. @TicketNumber or something).

badgerwithagun added a commit that referenced this issue Oct 26, 2017
…ed without injection of Upgrade or Deployment. (#37)
@badgerwithagun
Copy link
Member Author

@Jaffa, @tsg21, could you have a look at https://github.com/alfasoftware/morf/wiki/Start-Here and make any changes you think appropriate?

That's stage 1 out of the way...

@tsg21
Copy link
Member

tsg21 commented Oct 27, 2017

I've tweaked that to fix some typos, plus added wiki/Key-Features

@badgerwithagun
Copy link
Member Author

Sweet, cheers!

@badgerwithagun
Copy link
Member Author

Made some progress here.

Main remaining issues:

  • Lack of fluent SQL execution support (with me)
  • Removing JIRA ID from UpgradeStep

Then I think we can close this bit off and start working on documenting/improving the rest of the toolset.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

3 participants