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

feat: generate IDs which can be used to reference plans #93

Open
wants to merge 11 commits into
base: main
Choose a base branch
from

Conversation

rorybyrne
Copy link
Owner

What does this PR do?

Broadly, this PR introduces IDs/labels for plans, so that they can be referenced easily (e.g. git-plan commit --id GP-123)

Some highlights:

  • changes the word "commit" to be "plan", across the codebase
  • updates "plan_service" to reference plans instead of commits
  • fixes a bug where plans would be filtered using the wrong variable

Why are we doing this?

  • so that we can easily reference individual plans

Testing performed

Known issues

@rorybyrne rorybyrne self-assigned this Jul 22, 2024
What does this commit do?
=========================
* changes all references to "commit" to be "plan" instead
* updates "plan_service" to reference plans instead of commits
* fixes a bug where plans would be filtered using the wrong variable

Why are we doing this?
======================
* To avoid confusion around terminology - a plan is not the same as a commit

Notes
=====
What does this commit do?
=========================
* switches from repository model back to project
* renames all tests to work with projectionist.vim
* Removes @decorators from commands, and starts putting them on service
methods again

Why are we doing this?
======================
* the design of repository-model -> command decorators was bad
What does this commit do?
=========================
* Adds a "migration_service.py" file which can migrate planfiles from
the old format to the new
* Adds a "migrate.py" command which allows the user to migrate their
plans
* Adds a hook in the CLI which will check for required migration and
prompt the user.

Why are we doing this?
======================
* To migrate old plans to the new format (with "id")
@rorybyrne
Copy link
Owner Author

Closes #63

@rorybyrne rorybyrne marked this pull request as ready for review July 22, 2024 19:08
What does this commit do?
=========================
* Adds new targets to the Justfile for linting.
What does this commit do?
=========================
* Adds a `--id` flag to `gp commit`.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant